Skip to content

Open Research Bases

This is the future home of the Open Research Bases Group! We create template bases for the Open Journals organization of journals to drive reproducible, automated research and software development.

Resources

The following open source projects form the open bases:

Templates

Where are the bases?

We are putting together the first toy examples that will put together a selection of components from above to generate a fully reproducible generation to publication pipeline! Stay tuned.

Development

Documentation is done with mkdocs because it's easy to write markdown files. If you want to contribute, you can just change the content of the src folder. For details on customization and using the theme, please see the material theme pages.

Local

Here are the dependencies you should install:

pip install mkdocs mkdocs-material click-man

The resulting docs will be built from src into docs. The build and serve happens like this!

mkdocs serve

Then open your browser to http://127.0.0.1:8000

Docker

If you want, you can also develop in the container!

docker build -t openbases/openbases.github.io .
docker run --rm -v --port 8000:8000 $PWD/:/code openbases/openbases.github.io

Support

Please don't hesitate to reach out and ask us a question, or contribute!