Merge pull request #244 from fusion-energy/develop

Development updates

README.md

@@ -35,8 +35,10 @@ STP, STL, BRep, HTML and DAGMC h5m.
 
 :point_right: [Video presentation](https://www.youtube.com/embed/fXboew3U7rw)
 
-:point_right: [Installation](https://paramak.readthedocs.io/en/main/#system-installation)
+:point_right: [Installation](https://paramak.readthedocs.io/en/main/install.html)
 
 :point_right: [Publication](https://f1000research.com/articles/10-27)
 
 :point_right: [Docker images](https://github.com/fusion-energy/paramak/pkgs/container/paramak)
+
+:point_right: Examples with Neutronics [1](https://github.com/fusion-energy/magnetic_fusion_openmc_dagmc_paramak_example), [2](https://github.com/fusion-energy/inertial_fusion_openmc_dagmc_paramak_example), [3](https://github.com/fusion-energy/neutronics-workshop)

conda/meta.yaml

@@ -14,7 +14,8 @@ build:
 requirements:
   build:
     - python {{ python }}
-    - setuptools
+    - setuptools>=46.4.0
+    - setuptools_scm>=6.3.1
   run:
     - python {{ python }}
     - cadquery {{ cadquery }}

docs/source/install.rst

@@ -25,7 +25,8 @@ Anaconda, or Miniforge
 Once you have a version of Conda installed then proceed with the Paramak
 specific steps.
 
-Install (conda)
+
+Install (mamba)
 ---------------
 
 This is the recommended method.
@@ -37,6 +38,36 @@ Create a new environment (Python 3.8 and 3.9 are supported).
    conda create --name paramak_env python=3.8
 
 
+Then activate the new environment.
+
+.. code-block:: bash
+
+   conda activate paramak_env
+
+Then install mamba.
+
+.. code-block:: bash
+
+   conda install -c conda-forge mamba
+
+Then install the Paramak.
+
+.. code-block:: bash
+
+   mamba install -c fusion-energy -c cadquery -c conda-forge paramak
+
+Now you should be ready to import paramak from your new python environment.
+
+Install (conda)
+---------------
+
+Create a new environment (Python 3.8 and 3.9 are supported).
+
+.. code-block:: bash
+
+   conda create --name paramak_env python=3.8
+
+
 Then activate the new environment.
 
 .. code-block:: bash

paramak/__init__.py

@@ -1,6 +1,8 @@
 try:
+    # this works for python 3.7 and lower
     from importlib.metadata import version, PackageNotFoundError
 except (ModuleNotFoundError, ImportError):
+    # this works for python 3.8 and higher
     from importlib_metadata import version, PackageNotFoundError
 try:
     __version__ = version("paramak")
@@ -11,6 +13,7 @@
 
 __all__ = ["__version__"]
 
+
 from .shape import Shape
 from .reactor import Reactor
 from .utils import (

pyproject.toml

@@ -1,8 +1,8 @@
 [build-system]
 requires = [
-    "setuptools >= 45",
+    "setuptools >= 46.4.0",
     "wheel",
-    "setuptools_scm[toml] >= 6.2",
+    "setuptools_scm[toml] >= 6.3.1",
 ]
 build-backend = "setuptools.build_meta"
 

setup.cfg

@@ -1,5 +1,6 @@
 [metadata]
 name = paramak
+version = attr: paramak.__version__
 author = The Paramak Development Team
 author_email = [email protected]
 description = Create 3D fusion reactor CAD models based on input parameters
@@ -39,12 +40,12 @@ install_requires=
     setuptools_scm
 
 [options.extras_require]
-tests = 
+tests =
     pytest >= 5.4.3
     pytest-cov>=2.12.1
     pytest-runner>=5.3.1
     dagmc_h5m_file_inspector>=0.5.0
-docs = 
+docs =
     sphinx >= 4.1.2
     sphinx_rtd_theme
     sphinx_autodoc_typehints