Skip to content

README.md

Latest commit

 

History

History
54 lines (41 loc) · 1.77 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.77 KB
Raw

The HyperCells & HyperBloch website

This website serves as a comprehensive guide to the installation and usage of the HyperCells and HyperBloch packages, providing tutorials with detailed explanations ranging from simple examples to more advanced applications.

The website is online here: https://www.hypercells.net.

Table of contents

Authors

Main author and developer:
  Marcelo Looser

Coauthors:
  Patrick M. Lenggenhager (https://patrick-lenggenhager.github.io, plengg@pks.mpg.de)
  Tomáš Bzdušek (tomas.bzdusek@uzh.ch)

Building and viewing the website

  1. Install Python.
  2. Set up the environment, e.g., using venv:
python -m venv env
source env/bin/activate
pip install --upgrade pip
  1. Install the necessary Python packages
pip install -r requirements.txt
  1. Install make.
  2. Build HTML
make html
  1. Start a webserver in the directory build/html, e.g., in VSCode use the LiveServer extension.

Contact

To report issues, please use the issue tracker at https://github.com/HyperCells/HyperCells.github.io/issues.

License and copyright

See the attached LICENSE for details.

© 2024 Marcelo Looser, Patrick M. Lenggenhager, Tomáš Bzdušek