Skip to content

Commit

Permalink
rsxml page
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbaileynar committed Feb 17, 2024
1 parent 0726735 commit a3d7835
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 4 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions content/page/dev-tools/rsxml.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: RSXML
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 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.

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.
12 changes: 8 additions & 4 deletions gatsby-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,24 @@ module.exports = {
items: [],
},
{
title: 'API',
url: '/api',
title: 'Dev Tools',
url: '/dev-tools',
items: [
{
title: 'API',
url: '/api',
},
{
title: 'Command Line Interface',
url: '/api/rscli',
url: '/devl-tools/rscli',
},
{
title: 'Cyber Castor',
url: '/api/cyber-castor',
url: '/dev-tools/cyber-castor',
},
{
title: 'RSXML Python Package',
url: '/dev-tools/rsxml',
}
],
},
Expand Down

0 comments on commit a3d7835

Please sign in to comment.