Skip to content

Commit

Permalink
fix typos and broken links #8
Browse files Browse the repository at this point in the history
  • Loading branch information
weblorin authored and MattReimer committed Mar 4, 2025
1 parent a5b9945 commit fbe0b27
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion content/page/MIGRATED/Tools/toolStandards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When it comes to agricultural products, most consumers would agree that "organic

<Image to="/Tools/discrimination" src="/images/tools/grade/Tool_Badges_wText_All_700w.png" />

We define what we mean by these "tool grades" [here](/Tools/discrimination.html) and we use [Report Cards](/Tools/reportcards.html) and independent, peer-review to elaborate expectations. These standards make it clear what is expected of tool developers wishing to use the badge, and it makes it clear to users what they can expect from such tools. Moreover, we provide easier pathways for researchers and tool developers to achieve such status (with clear guidelines and technical references) as well as making it easier for lower-grade (e.g. operational-grade and research-grade) tools to leverage professional-grade and commercial-grade tools (e.g. [Riverscapes Viewer](https://rave.riverscapes.net) and [Riverscapes Warehouse](https://data.riverscapes.net)) and reach broader audiences.
We define what we mean by these "tool grades" [here](/Tools/discrimination.html) and we use [Report Cards](./reportcards) and independent, peer-review to elaborate expectations. These standards make it clear what is expected of tool developers wishing to use the badge, and it makes it clear to users what they can expect from such tools. Moreover, we provide easier pathways for researchers and tool developers to achieve such status (with clear guidelines and technical references) as well as making it easier for lower-grade (e.g. operational-grade and research-grade) tools to leverage professional-grade and commercial-grade tools (e.g. [Riverscapes Viewer](https://viewer.riverscapes.net) and [Riverscapes Data Exchange](https://data.riverscapes.net)) and reach broader audiences.



Expand Down
6 changes: 3 additions & 3 deletions content/page/dev-tools/rsxml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ description: A free, public Python package for authoring Riverscapes projects
banner: true
---

The [Riverscapes Consortium](https://riverscapes.net) has developed a standard for packaging data related to riverscapes health so that it can be shared and discovered via the [Riverscape Data Exchange](https://data.riverscapes.net).
The [Riverscapes Consortium](https://riverscapes.net) has developed a standard for packaging data related to riverscapes health so that it can be shared and discovered via the [Riverscapes Data Exchange](https://data.riverscapes.net).

The standard consists of a small, simple XML text file that sits in the root folder of the data being described. This file lists all the datasets, reports, log files etc. It is the backbone of the Riverscapes Data Exchange and is what allows for effective curation and discovery of data. The file is always called `project.rs.xml`. It can be written by hand, but is much easier if you script its generation to avoid mistakes or increase reuse.
The standard consists of a small, simple XML text file that sits in the root folder of the data being described. This file lists all the datasets, reports, log files etc. It is the backbone of the Riverscapes Data Exchange and is what allows for effective curation and discovery of data. The file is always called `project.rs.xml`. It can be written by hand, but is much easier if you script its generation to avoid mistakes and increase reuse.

RSXML is a free, public Python package that allows Riverscapes tool developers to easily author `project.rs.xml` project files. It is available as a pip module from the PyPi online respoitory of Python packages.

[https://pypi.org/project/rsxml/](https://pypi.org/project/rsxml/)

RSXML includes documentation on how to use it to author projects, including code examples. Contact a Riverscapes Application Support Specialist ([email protected]) if you have data that you want to add to the Riverscapes Data Exchange and need help using RSXML to author project files.
RSXML includes documentation on how to use it to author projects, including code examples. Contact a Riverscapes Application Support Specialist ([email protected]) if you have data that you want to add to the Riverscapes Data Exchange and need help using RSXML to author project files.
2 changes: 1 addition & 1 deletion content/page/standards/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Riverscapes research, like many disciplines, is held back by too many technology

Follow these steps, all of which are underpinned by the [FAIR principles](https://www.go-fair.org/fair-principles/), to apply the riverscapes standards to your data.

1. Ensure that all the data are in open, non-proprietary formats. This is especially important for geospatial data. We recommend GeoTIFF files for rasters and [GeoPackages](https://www.geopackage.org/) for vector data. Shapefiles, although a published format are discouraged for [numerous reasons](http://switchfromshapefile.org/).
1. Ensure that all the data are in open, non-proprietary formats. This is especially important for geospatial data. We recommend GeoTIFF files for rasters and [GeoPackages](https://www.geopackage.org/) for vector data. Shapefiles, although a published format, are discouraged for [numerous reasons](http://switchfromshapefile.org/).
2. Organize the data into a logical file and folder structure. Use common sense and think about how users will consume the data. There are no specific rules about the folder structure.
3. Provide an accompanying XML file called `project.rs.xml` at the root of the folder structure. This XML file has a strict, but helpful structure that helps catalog the individual data files. This XML file must refer to the latest version of the [Riverscapes Data Standards](https://github.com/Riverscapes/RiverscapesXML/blob/master/Projects/XSD/V2/RiverscapesProject.xsd). The best way to ensure compliance is to refer to the XSD file and then validate your XML file using a tool such as Visual Studio Code. Data with a `project.rs.xml` file that does not validate cannot be incorporated into the Riverscapes Data Exchange.
4. Ensure that the `project.rs.xml` file includes appropriate metadata to help others understand and leverage your data. This is your chance to help future you remember all the nitty gritty details about where the data originated, how it was processed and any limitations on its use.

0 comments on commit fbe0b27

Please sign in to comment.