Skip to content

CONTRIBUTOR.md

Latest commit

 

History

History
55 lines (30 loc) · 2.17 KB

CONTRIBUTOR.md

File metadata and controls

55 lines (30 loc) · 2.17 KB

How to use

This project uses jupyter-book to build the materials for the Automated Scientific Discovery of Mind and Brain Workshop.

Building the book

To build the book locally, you will need to have Python installed. You can then install the required dependencies using pip (best after creating a virtual environment):

pip install -r requirements.txt

First make sure you build the schedule. You can do this by running:

python build_schedule.py

To build the book, navigate to the root directory of the project and run:

jupyter-book build ASDMB_book

This will generate the book in the ASDMB_book/_build/html directory. You can then open the index.html file in your web browser to view the book.

Sometimes you might need to clean the build directory before building again. You can do this by running:

jupyter-book clean ASDMB-book --all

Contributing

To contribute to the book, most of the time you will only need to edit files in the ASDMB_book/content directory. You can add new chapters and sections, or modify existing ones. The book is written in Markdown and Jupyter Notebooks for the tutorials.

You might also have to modify the ASDMB_book/_toc.yml file to update the table of contents.

Schedule

If you want to change the content of the schedule, please update ASDMB_book/content/data/schedule.yampl. The ids have to match the corresponding folders in ASDMB_book/content/presentations. In the folders, you can add slides (pdf or pptx).

Speakers

If you want to change the content of the speakers page, please update ASDMB_book/content/data/speakers.yaml. If you match names with the names provided in schedule.yaml, the links to the talks will be generated automatically.

Please follow these guidelines when contributing:

  • Use a separate branch for you changes and make a pull request when you are done.
  • Pushing to the main branch will trigger a build of the book using GithubActions. Make sure your changes do not break the build (you can check this by first building locally, but you should also check the build status on your pull request and make sure it passes).