nmag-python-3 0.0.2__tar.gz → 0.0.3__tar.gz

{nmag_python_3-0.0.2/src/nmag_python_3.egg-info → nmag_python_3-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nmag-python-3
-Version: 0.0.2
+Version: 0.0.3
 Summary: Standalone Python 3 implementation of the Nmag micromagnetic simulation interface
 Author-email: TriMagnetix <info@trimagnetix.com>
 Classifier: Programming Language :: Python :: 3
@@ -58,9 +58,27 @@ and [quickstart](https://trimagnetix.github.io/nmag-python-3/getting-started/qui
 
 ## Installation
 
-From a clone of this repository:
+If you only want to run Nmag and do not need the source code, install the
+published package in a virtual environment:
 
 ```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install --upgrade pip
+.venv/bin/python -m pip install nmag-python-3
+```
+
+You can then run a simulation with:
+
+```bash
+.venv/bin/python simulation.py
+```
+
+To work from the source repository or contribute to Nmag, clone the repository
+and use its setup script instead:
+
+```bash
+git clone https://github.com/TriMagnetix/nmag-python-3.git
+cd nmag-python-3
 ./scripts/setup.sh
 ```
 

{nmag_python_3-0.0.2 → nmag_python_3-0.0.3}/README.md

@@ -20,9 +20,27 @@ and [quickstart](https://trimagnetix.github.io/nmag-python-3/getting-started/qui
 
 ## Installation
 
-From a clone of this repository:
+If you only want to run Nmag and do not need the source code, install the
+published package in a virtual environment:
 
 ```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install --upgrade pip
+.venv/bin/python -m pip install nmag-python-3
+```
+
+You can then run a simulation with:
+
+```bash
+.venv/bin/python simulation.py
+```
+
+To work from the source repository or contribute to Nmag, clone the repository
+and use its setup script instead:
+
+```bash
+git clone https://github.com/TriMagnetix/nmag-python-3.git
+cd nmag-python-3
 ./scripts/setup.sh
 ```
 

{nmag_python_3-0.0.2 → nmag_python_3-0.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nmag-python-3"
-version = "0.0.2"
+version = "0.0.3"
 authors = [{ name = "TriMagnetix", email = "info@trimagnetix.com" }]
 description = "Standalone Python 3 implementation of the Nmag micromagnetic simulation interface"
 readme = "README.md"

{nmag_python_3-0.0.2 → nmag_python_3-0.0.3/src/nmag_python_3.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nmag-python-3
-Version: 0.0.2
+Version: 0.0.3
 Summary: Standalone Python 3 implementation of the Nmag micromagnetic simulation interface
 Author-email: TriMagnetix <info@trimagnetix.com>
 Classifier: Programming Language :: Python :: 3
@@ -58,9 +58,27 @@ and [quickstart](https://trimagnetix.github.io/nmag-python-3/getting-started/qui
 
 ## Installation
 
-From a clone of this repository:
+If you only want to run Nmag and do not need the source code, install the
+published package in a virtual environment:
 
 ```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install --upgrade pip
+.venv/bin/python -m pip install nmag-python-3
+```
+
+You can then run a simulation with:
+
+```bash
+.venv/bin/python simulation.py
+```
+
+To work from the source repository or contribute to Nmag, clone the repository
+and use its setup script instead:
+
+```bash
+git clone https://github.com/TriMagnetix/nmag-python-3.git
+cd nmag-python-3
 ./scripts/setup.sh
 ```