Skip to content

helenahartmann/ARIADNE

 
 

Repository files navigation

ARIADNE

ARIADNE Logo

The freely available, curated and dynamically “living” tool ARIADNE spans the whole research process and is translated to a dynamic interface for easier use and search for the individual resources.

Included in this repo, is the network backend of ARIADNE-resource and the Jupyter-notebook instance of the living book. Please also have a look at the preprint and website to this tool.

Contributors to ARIADNE:

License

MIT License

Usage / Reproducing

If you want to reproduce and host the book by yourself.

This cookiecutter creates a simple boilerplate for a Jupyter Book.

Building the book

If you'd like to develop and/or build the TestBook book, you should:

  1. Clone this repository
  2. Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
  3. (Optional) Edit the books source files located in the ariadne/ directory
  4. Run jupyter-book clean ariadne/ to remove any existing builds
  5. Run jupyter-book build ariadne/

A fully-rendered HTML version of the book will be built in ariadne/_build/html/.

Hosting the book

Please see the Jupyter Book documentation to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the cookiecutter-jupyter-book includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose github for the include_ci cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the gh-pages branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab. If you want to contribute a new resource, please do so here. More detailed instructions will follow soon!

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.

About

The main repository for ARIADNE responsive book!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.9%
  • HTML 1.9%
  • TeX 0.6%
  • CSS 0.2%
  • JavaScript 0.2%
  • Jupyter Notebook 0.1%
  • Other 0.1%