README.md

scientificcomputing.github.io

The resources for generating https://scientificcomputing.github.io/.

How to add a paper with repository?

Please fill in https://github.com/scientificcomputing/scientificcomputing.github.io/issues/new?assignees=&labels=new-repo&projects=&template=repository.yml&title=%5BAdd+repo%5D%3A+

How to add a paper relating to a software?

Please fill in https://github.com/scientificcomputing/scientificcomputing.github.io/issues/new?assignees=&labels=new-package&projects=&template=package.yml&title=%5BAdd+package%5D%3A+

Contribute to the webpage

To contribute, please make a fork of the repository and clone it to your local system, then make a new branch with

git checkout -b name_of_author/describe_feature

Then add the relevant text. Next ensure that the webpage builds, this can be done with

python3 -m venv sc_webpage_env
source sc_webpage_env/bin/activate
python3 -m pip install .
cd docs
jupyter book build --html --check-links --strict

Inspect the webpage locally by running

python3 -m http.server -d  _build/html 8000

and opening a browser at http://localhost:8000.

Before you push the changes, ensure that the text is properly formatted, run

pre-commit run --all

Then, make corrections and commit any changes before re-running pre-commit.

Push the branch to your fork, and then make a pull request through the github web-interface.