For issue tracking visit: issues and boards

Proposed Readme template follows:

Graphene-Synthesis-Analysis

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Bump2version is used to increment the version and apply tags. The basic setup follow tha guidlines illustrated here. All version bumps should happen on a clean working copy of the repository, after the last commit for that version has been pushed. The push of the the bump2version changes will comprise the version.

Example bump2version commands

$ cat VERSION
0.0.0$ bumpversion major; cat VERSION
1.0.0-dev0$ bumpversion minor; cat VERSION
1.1.0-dev0$ bumpversion patch; cat VERSION
1.1.1-dev0$ bumpversion build; cat VERSION
1.1.1-dev1$ bumpversion build; cat VERSION
1.1.1-dev2$ bumpversion --tag release; cat VERSION
1.1.1$ bumpversion minor; cat VERSION
1.2.0-dev0

Relavant files

.bumpversion.cfg
VERSION
src/gsaraman/__init.py
setup.py

Development Versions

For commits that are to be merged to master for further testing, a development version should be created.

Tagged Releases

nanoHUB Release Procedure

1. Test code on nanoHUB using the nanoHUB Jupyter Notebook tool.

2. Ensure all relavent code and implementation reviews have been approved.

3. Check VERSION and use bump2version, if needed (see Versioning above). For final releaseto remove the "-dev" designation from the version string, use the following bumpversion command: bumpversion --tag release
   or
   bumpversion --no-tag release
   the former can be done directly in master while the second option can be done in a development branch (and merged to master via PR), or master directly.

4. Merge or changes to master via PR. (May entail code or implementation review).

5. Click the "..please instal latest..." link on nanoHUB tool status page: https://nanohub.org/tools/graft/status and wait for tool status to be installed.

6. Test installed tool (May entail implementation review).

7. Approve installation. Again done in the tool status page. Make sure nanoHUB version string matches the one genrated above.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc