Add to pypi

.github/workflows/build_publish.yaml

@@ -0,0 +1,25 @@
+name: Build and Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -7,7 +7,7 @@ F4Epurity is a python-based tool that can be used to approximate the change in a
 
 The tool works for a point or line deviation and outputs a 3D map of the deviation in dose in *vtr* format. This dose field assumes unshielded and unscattered conditions.  
 
-Instruction on installation and usage of the tool can be found at [INSERT LINK]
+Instruction on installation and usage of the tool can be found in the [code documentation](https://f4epurity.readthedocs.io/en/stable/index.html)
 
 ## Reporting Bugs
 

docs/source/installation.rst

@@ -4,17 +4,14 @@ Installation
 
 **Python versions lower than 3.10 are not supported (tested versions are 3.10 and 3.11). Both Windows and Linux OS are supported.**
 
-It is recommended that the user sets up a virtual environment to install the code. The following steps detail the setup of a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ and installation of the tool.
+F4Epurity is available on PyPi. It can simply be installed using pip:
 
 .. code-block:: bash
 
-    python3 -m venv env
+    pip install f4epurity
 
-Activate the virtual environment. When activated, the package and all of its dependencies will be installed into the virtual environment.
-
-.. code-block:: bash
-
-    source env/bin/activate
+Developer installation
+=======================
 
 Clone the repository containing the code from the `GitHub repository <https://github.com/Fusion4Energy/F4Epurity>`_. Note that for users without Git installed, you can instead download an archive of the repository. See `here <https://docs.github.com/en/repositories/working-with-files/using-files/downloading-source-code-archives>`_.