This is a resource collecting and structuring knowledge and training materials for the two strongly interlinked areas of data management for nanomaterials and nanoinformatics. Besides covering general concepts, guidelines and recommendations, it will show, demonstrate and train real-world solutions in the form of data sources, software and workflows integrated or linked into the NanoCommons infrastructure, where both terms are meant in a very broad sense to be able to cover as many solutions as possible from all projects working in the nanosafety area and neighbouring fields.
The latest published version of the handbook is available at https://nanocommons.github.io/user-handbook/
This project uses the Jekyll static site generator. The Jekyll theme used is Just the Docs.
The pages are served via GitHub Pages and are rebuilt on every commit to the main branch.
When writing new or extending the existing content, it is quite helpfull to have your local development setup in place. This way, you'll be able to see and verify your changes immediately.
The two requirements for the local development setup are the Ruby programming language and the Jekyll. Please follow the installation instructions for the two requirements. Note: your system may already have the Ruby programming language installed.
Once you have completed the setup, you need to install the required ruby modules (gems) by:
bundle update
You need to run this once when setting up your environment and, optionally, when you (or others) add additional modules.
Finally, to run the development server run:
bundle exec jekyll serve
Point your browser to http://127.0.0.1:4000/user-handbook/ and you should see your local version of the NanoCommons User Handbook.
Happy writing!