fispact.github.io

This repository contains the source for the FISPACT-II GitHub pages. These pages provide a set of reference material for FISPACT-II and are intended to supplement the information available in the FISPACT-II manual.

These pages are available at https://fispact.github.io/.

For an overview of FISPACT-II, contact information, and details on licencing, please refer to the FISPACT-II homepage.

Contributing

The FISPACT-II website is developed and is maintained by the United Kingdom Atomic Energy Authority at Culham. If you are interested in participating in the development of this website, please contact the development team through the UKAEA contact page or FISPACT-II discussion board.

Building the Website Locally

This website is build using Zensical, which converts the plain text markdown files in the docs directory into the website.

If you would like to build the pages locally you will need a local installation of git and python.

First clone this repo e.g.,

git clone https://github.com/fispact/fispact.github.io.git fispact-website

Then change directory into your local copy of the repo:

cd fispact-website

We recommend to work in a python virtual environment, as you will need to install zensical and its dependencies. To create a new virtual environment run:

python -m venv .venv

Next, activate the virtual environment:

source .venv/bin/activate

Then install this repository into your virtual environment:

python -m pip install -e .

Note, that you will need to install this repository, rather than installing Zensical directly, as we use some custom python markdown extensions for some of the formatting on the website.

Finally, you should be able to build and serve the website locally by running:

zensical serve

This will start a local webserver at http://localhost:8000, which you can paste into your browser to see the website.