A collection of python tools for creating GEOMS files
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
### GEOMS manipulate attributes geomsma
Manipulate attributes in an existing GEOMS file (type hdf, h5 or nc): the input target GEOMS filename is used to set the new FILE\_NAME,DATA\_SOURCE,DATA\_FILE\_VERSION attributes. Other attributes are set with pairs of arguments
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
### GEOMS extract metadata as datacite.xml or a html landing page (for EVDC use... but easily adaptable through jinja template)
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
For a new site, you will have to add some information to the script: add persons' ORCID id, add the institutes' ROR+logo+url, ... until you think there is enough metadata in the output (this could go into a separate config file ...). There are examples in the script of such information for BIRA-IASB.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Example usage for an EVDC DOI request:
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
> Generate the DOI string from a single file: `doi=$(./geomsdoi.py -t evdc_doi_construct $f)`
> Create a new GEOMS file containing the DOI (and increment version number): `./geomsma.py $f ${f/001.hdf/002.hdf} DATA_MODIFICATIONS "File version 002: added DOI" FILE_DOI ${doi}`
> Extract the metadata from the new file: `./geomsdoi.py -t evdc_langing_page ${f/001.hdf/002.hdf}` and `./geomsdoi.py -t evdc_datacite_xml ${f/001.hdf/002.hdf}`
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
If you want to have more contributors in the metadata: the script will check the DATA_DESCRIPTION attribute for known persons (lastname;firstname as in the PI\_NAME attributes)
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
The underlying structure is explained in a string in the header of the script.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
MIT License
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
