Merge pull request #15 from fusion-energy/develop

Develop

.github/workflows/python-publish.yml

@@ -26,8 +26,8 @@ jobs:
         pip install setuptools wheel twine
     - name: Build and publish
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}  # TODO change to token
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: |
         python setup.py sdist bdist_wheel
         twine upload dist/*

README.md

@@ -13,7 +13,9 @@ The Paramak python package allows rapid production of 3D CAD models of fusion
 reactors. The purpose of the Paramak is to provide geometry for parametric
 studies. The paramak can created geometry in standard CAD formats such as STP,
 STL. It can also create h5m files for 
-[DAGMC](https://svalinn.github.io/DAGMC/) based neutronics simulations.
+[DAGMC](https://svalinn.github.io/DAGMC/) and carry out neutronics simulations
+when used with the optional [paramak-neutronics](https://github.com/fusion-energy/paramak-neutronics)
+module.
 
 :point_right: [Documentation](https://paramak.readthedocs.io)
 
@@ -23,6 +25,9 @@ STL. It can also create h5m files for
 
 :point_right: [Publication](https://f1000research.com/articles/10-27/v1)
 
+:point_right: [Docker images](https://github.com/fusion-energy/paramak/pkgs/container/paramak)
+
+
 
 ## Citing
 

docs/source/index.rst

@@ -28,6 +28,10 @@ means a finished product. Contributions are welcome. CadQuery functions provide
 the majority of the features, and incorporating additional capabilities is
 straightforward for developers with Python knowledge.
 
+You might also be interested in the `paramak-neutronics <https://github.com/fusion-energy/paramak-neutronics>`_   
+which is a separate module that adds neutronics capabilties.
+
+
 .. raw:: html
 
       <iframe width="560" height="315" src="https://www.youtube.com/embed/fXboew3U7rw" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
@@ -40,14 +44,12 @@ straightforward for developers with Python knowledge.
    paramak.parametric_shapes
    paramak.parametric_components
    paramak.parametric_reactors
-   paramak.parametric_neutronics
    paramak.shape
    paramak.reactor
    paramak.utils
    example_parametric_shapes
    example_parametric_components
    example_parametric_reactors
-   example_neutronics_simulations
    tests
 
 History
@@ -71,7 +73,7 @@ The code has been professionally reviewed by
 and inline `suggestions <https://github.com/ukaea/paramak/pull/639>`_.
 
 The Paramak source code is distributed with a permissive open-source license
-(MIT) and is avaialbe from the GitHub repository 
+(MIT) and is available from the GitHub repository 
 `https://github.com/fusion-energy/paramak <https://github.com/fusion-energy/paramak>`_
 
 Publications and Presentations

docs/source/paramak.install.rst

@@ -20,21 +20,27 @@ Python 3 and CadQuery can be installed using Conda or Miniconda
 Once you have Conda or MiniConda installed then CadQuery can be installed
 into a new enviroment and that environment can be activated using Anaconda or Miniconda. 
 
-Cadquery 2 can be installed in a Conda environment via conda-forge.
+First create a new enviroment.
 
 .. code-block:: python
 
-   conda create -n paramak_env -c conda-forge -c cadquery python=3.8 cadquery=2.1
+   conda create --name paramak_env python=3.8
 
 
-Once you have activated a conda environment, Cadquery 2 can be installed
-using the command:
+Then activate the new enviroment.
 
 .. code-block:: python
 
    conda activate paramak_env
 
 
+Then install CadQuery.
+
+   .. code-block:: python
+
+   conda install -c conda-forge -c cadquery cadquery=2.1
+
+
 A more detailed description of installing Cadquery 2 can be found here:
 
 * `Cadquery 2 installation <https://cadquery.readthedocs.io/en/latest/installation.html>`_
@@ -53,7 +59,7 @@ Alternatively you can download the repository using the `download link <https://
 
 .. code-block:: bash
 
-   git clone https://github.com/Shimwell/paramak.git
+   git clone https://github.com/fusion-energy/paramak.git
 
 Navigate to the paramak repository and within the terminal install the paramak
 package and the dependencies using pip3.
@@ -72,11 +78,7 @@ You can also install optional dependencies that add some neutronics
 capabilities to the paramak. This will install neutronics_material_maker and
 parametric_plasma_source. In addition to this you would need DAGMC, OpenMC,
 MOAB and Trelis / Cubit.
-`More details <https://paramak.readthedocs.io/en/latest/paramak.parametric_neutronics.html>`_
-
-.. code-block:: bash
-
-   pip install .[neutronics]
+`More details <https://paramak-neutronics.readthedocs.io>`_
 
 You could consider installing
 [jupyter-cadquery](https://github.com/bernhard-42/jupyter-cadquery) which adds