Help Page
The LWI is using EnDMC as the data and model repository to promote the discoverability, reproducibility, and reuse of existing models. The term catalog is used across this site—and in place of repository—to denote the central purpose of the system: making a curated, discoverable list of resources.
Metadata is an integral piece of this catalog. Metadata is structured information, understandable by humans and machines, that describes, explains, and makes it easier to retrieve, use, and manage an information resource included in the data and model catalog. As such, metadata enables the resources included within the catalog to be discoverable, trusted, replicable, and reusable.
Metadata should be created by the person who is responsible for submitting a specific resource to the catalog. This individual is the creator, collector, or expert user of that resource and is therefore familiar with the specific resource and can provide a description of it. This guide is intended for metadata authors, who have the responsibility to create the high-quality metadata needed to make the catalog useful.
To create metadata, please use the “Create” tab from the top menu. Note that you will need an editor role in order to create metadata. Below is a summary of the metadata specifications for models that were developed by The Water Institute.
To review existing metadata files, please use the “See all” tab from the top menu and select the type of metadata you are looking for.
To upload your model/simulation files, go to the “See all” tab and identify the metadata for which you want to upload files. Open it, scroll to the bottom of the page, and drag and drop your file in the “resource file” section.
To search within the repository, please use the “Search” tab from the top menu and use keywords to search for the best model that fits your need. You can use the filters on the left to customize your search.
METADATA STRUCTURE
FILE UPLOAD
Model files and dataset files should be uploaded in EnDMC to make them available for other users, as scoped in TO4 and as specified in the LWI Data Governance and modeling guidance methodology documents.
Each file will be associated with, e.g. a specific model application (when the file is shared across multiple simulations), or simulation. No files should be uploaded for software, software version or packages. To upload your model file(s), go to the “See all” tab and identify the metadata for which you want to upload files. Open it, scroll to the bottom of the page, and drag and drop your file(s) in the “Upload Files” section. You can also select or drag and drop an entire folder. Do not upload zipped folders; as this will prevent the system and future users from seeing what is or is not within the zipped directory.
If the files shared across multiple simulations were already uploaded at the model application level, they should not be uploaded again at the simulation level (or this would create unnecessary duplication). EnDMC will include them when displaying the files for that simulation.
Please note that, depending on the software used, and on the model setting that the user choses, it might be more convenient to upload all files at the simulation level or all files at the model application level, instead of splitting them. The modeler who uploads the file(s), and likely is very familiar with the model set up, should use their best professional judgment. For example, in case of HEC-HMS and HEC-RAS models, the files are often organized in such a way that it is not convenient to separate the files used for a single simulation/plan. In that case, please upload all files at the model application level even if you are describing them in the simulation metadata. This would be most akin to how HEC models are passed from one user to another in present terms, often by having all required files in one directory. Make sure to include the right paths in the input/output file description.
If, for whatever reason, the files cannot be uploaded (e.g., they need to be saved somewhere else), make sure to include the link to them (URL link or location path) when creating the metadata under the “Model File External Location” field.
RESOURCE SEARCH
There are two ways to search for a resource (Software, Model Application, etc.) in EnDMC: using text (e.g., keywords) or the geographic search tool. For both ways, the search bar at the top of the page should be used.
To search using text, type the desired keyword in the bar and click the magnifying glass icon. Users can optimize their search by specifying in which metadata field they want to focus the search. For example:
- To focus the search on the keyword metadata field only, enter "keywords:[your search term]"
- To focus the search on the title metadata field only, enter "title:[your search term]"
For more, see the advanced search page.
To search using the geographic map tool, click on the icon in the search bar at the top of the page. Then select the type of spatial filter you want to use (e.g., Parish, huc8, huc12, etc.) and click the magnifying glass icon.
Both ways of searching will bring you to the search result page, which has two views: “List View” and “Map View”. The page will automatically direct you to the last view you used. If it is the first time using EnDMC, the text search will bring you to the “List View” and the geographic search will bring you to the “Map View”. Users can easily switch between views by clicking on the desired tab.
In the “List View”, a list of resources corresponding to the search initiated by the user, will be displayed. The search can be further refined by using the list of filters in the left column and clicking “Apply” at the bottom. User can click on the desired resource to visualize the metadata of that resource and download the associated files.
In the “Map View”, a map showing the number of available resources (e.g., number of Model Applications) will be visualized. By clicking on each hexagon, a list of existing resources that cover that area will be provided. Each entry can be selected to visualize the detailed metadata page associated with it and access the files. If the user selected some spatial filters, the map automatically zooms over that area and shows the extent of that spatial filter (e.g., district, parish, huc8, huc12, etc.). Only the resources whose intended use area intersects with the selected spatial filter will be displayed. Similarly to the “List View”, the search can be further refined by using the list of filters in the left column and clicking “Apply” at the bottom.
USER PERMISSIONS
EnDMC can support different access levels for different users. Each user is initially created as User (see table below), but they can request other roles when creating their account. This different role has to be approved by an Admin.
Permissions are related to the ability to view metadata, view and download files associated with that metadata, create new entries (i.e., new metadata with their files), manage user roles and storage. Resources can be public or private. When a resource is created, it is initially categorized as “unreviewed”, meaning that it is visible only to its creator and admin users. Admins can then change the resource access level to “Private” or “Public”, which will make the resource visible to other user groups as shown in the table below.
The following table summarizes each user role’s permissions.
| User role | View Public resources metadata | View and download Public resources files | View Private resource metadata | View and download Private resources files | Create new resources | Edit their resources | Edit other resources | Manage users, storage and resource access |
|---|---|---|---|---|---|---|---|---|
| Anonymous User (not logged in) | YES | NO | NO | NO | NO | NO | NO | NO |
| User | YES | YES | NO | NO | NO | NO | NO | NO |
| Authorized User | YES | YES | YES | YES | NO | NO | NO | NO |
| Editor | YES | YES | NO | NO | YES | YES | NO | NO |
| Authorized Editor | YES | YES | YES | YES | YES | YES | NO | NO |
| Admin | YES | YES | YES | YES | YES | YES | YES | YES |
FREQUENTLY ASKED QUESTIONS
Where can I learn more about the features of EnDMC?
Overview of EnDMC functionality video (13 mins)
What browser should I use to access the catalog?
For the best experience, please use Chrome or Firefox.
Is there any file size limit?
Currently the upload file size limit is 100GB. Please do not upload zipped folders.
Where can I find EnDMC Desktop, which will help automate metadata creation for HEC models?
Here is a link to download EnDMC Desktop.
Do you have an API?
Yes. Please see the API documentation page. If you are an editor, you can create an access token on your account page.
Figure 1. Schematic representation of the layered approach for metadata, resource types and their relationships.
Figure 2. Diagram shows five layers of the Metadata Creation Tool and gives examples of the level of information that needs to be captured at each layer.