Skip to content

Commit a7fca8c

Browse files
authored
removed numpy version pin due to new cq release (#367)
* removed pypi pin * removed numpy pin * removed env yaml; * using python action instead of conda * avoiding pkg error * added setup tools to docs * added import test * added venv to docs
1 parent 0536cff commit a7fca8c

File tree

5 files changed

+36
-49
lines changed

5 files changed

+36
-49
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,19 @@ jobs:
2525
- name: checkout actions
2626
uses: actions/checkout@v4
2727

28-
- uses: mamba-org/setup-micromamba@v1
28+
- name: Set up Python ${{ matrix.python-version }}
29+
uses: actions/setup-python@v5
2930
with:
30-
micromamba-version: '1.5.8-0' # any version from https://github.com/mamba-org/micromamba-releases
31-
environment-file: environment_dev.yml
32-
init-shell: bash
33-
cache-environment: true
34-
post-cleanup: 'all'
31+
python-version: ${{ matrix.python-version }}
3532

3633
- name: install dependencies
37-
shell: bash -el {0}
38-
run: python -m pip install .[tests]
34+
run: |
35+
python -m pip install .
36+
python -c "import paramak"
3937
4038
- name: Test with pytest
41-
shell: bash -el {0}
4239
run: |
40+
python -m pip install .[tests]
4341
pytest -v
4442
python examples/plasma.py
4543
python examples/spherical_tokamak_from_plasma_minimal.py

.github/workflows/documentation_update.yml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ jobs:
1818
test:
1919
name: Documentation
2020
runs-on: ubuntu-latest
21+
strategy:
22+
matrix:
23+
python-version: ["3.12"]
24+
2125
steps:
2226
- name: Install system packages
2327
run: |
@@ -27,21 +31,16 @@ jobs:
2731
- name: checkout actions
2832
uses: actions/checkout@v4
2933

30-
- uses: mamba-org/setup-micromamba@v1
34+
- name: Set up Python ${{ matrix.python-version }}
35+
uses: actions/setup-python@v5
3136
with:
32-
micromamba-version: '1.5.8-0' # any version from https://github.com/mamba-org/micromamba-releases
33-
environment-file: environment_dev.yml
34-
init-shell: bash
35-
cache-environment: true
36-
post-cleanup: 'all'
37+
python-version: ${{ matrix.python-version }}
3738

3839
- name: install dependencies
39-
shell: bash -el {0}
4040
run: python -m pip install .[docs]
4141

4242
- name: Sphinx build tagged version
4343
if: startsWith(github.ref, 'refs/tags/')
44-
shell: bash -el {0}
4544
run: |
4645
sphinx-build docs _build/${{ github.ref_name }}
4746
rm -rf _build/stable
@@ -50,7 +49,6 @@ jobs:
5049
5150
- name: Sphinx build dev version
5251
if: (github.event_name == 'push' || github.event_name == 'pull_request') && !startsWith(github.ref, 'refs/tags/')
53-
shell: bash -el {0}
5452
run: |
5553
rm -rf _build/dev
5654
mkdir -p _build/dev

docs/install.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
Install
22
=======
33

4+
You might wish to create a virtual environment to install Paramak into. This can be done using the venv module in Python. For more information, see the `official Python documentation <https://docs.python.org/3/library/venv.html>`_.
5+
6+
.. code-block:: bash
7+
8+
python -m venv paramak-venv
9+
source paramak-venv/bin/activate
10+
11+
412
Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can be installed using pip.
513

614
.. code-block:: bash
715
8-
pip install paramak
16+
python -m pip install paramak
17+
918
1019
1120
.. Prerequisites
@@ -31,7 +40,7 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
3140
3241
.. .. code-block:: bash
3342
34-
.. mamba create --name paramak_env python=3.11
43+
.. mamba create --name paramak_env python=3.12
3544
3645
3746
.. Then activate the new environment.
@@ -56,7 +65,7 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
5665
5766
.. .. code-block:: bash
5867
59-
.. conda create --name paramak_env python=3.11
68+
.. conda create --name paramak_env python=3.12
6069
6170
6271
.. Then activate the new environment.
@@ -78,11 +87,12 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
7887
Developer Installation
7988
----------------------
8089

81-
If you want to contribute to the paramak or then you might want to install the
82-
package in a more dynamic manner so that your changes to the code are readily available.
90+
If you want to contribute to Paramak or then you might want to install the
91+
package in a more dynamic manner so that your changes to the code are readily
92+
available.
8393

84-
Download and install MiniConda, create a new python environment and activate the
85-
environment as covered in the installation procedure above.
94+
Create a new Venv, Conda or Mamba virtual environment and activate the
95+
environment as covered in the installation procedure above
8696

8797
Then clone the repository
8898

environment_dev.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

pyproject.toml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[build-system]
2-
requires = ["setuptools >= 69.5.1", "setuptools_scm[toml]>=8.1.0"]
2+
requires = ["setuptools>=72.1.0", "setuptools_scm[toml]>=8.1.0"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
@@ -19,8 +19,8 @@ license = {file = "LICENSE.txt"}
1919
requires-python = ">=3.8"
2020
keywords = ["python", "geometry", "reactor", "model", "cad", "fusion", "parametric", "dagmc", "openmc"]
2121
dependencies = [
22-
"cadquery",
23-
"numpy<=1.26.4",
22+
"cadquery>=2.5.2",
23+
"numpy",
2424
"mpmath",
2525
"sympy",
2626
"scipy",
@@ -47,7 +47,8 @@ docs = [
4747
"pydata-sphinx-theme",
4848
"cadquery",
4949
"ipython",
50-
"sphinx_design"
50+
"sphinx_design",
51+
"setuptools",
5152
]
5253

5354
[tool.black]

0 commit comments

Comments
 (0)