FourCIPP 0.29.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

fourcipp/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.29.0'
-__version_tuple__ = version_tuple = (0, 29, 0)
+__version__ = version = '1.1.0'
+__version_tuple__ = version_tuple = (1, 1, 0)
 
 __commit_id__ = commit_id = None

{fourcipp-0.29.0.dist-info → fourcipp-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FourCIPP
-Version: 0.29.0
+Version: 1.1.0
 Summary: A streamlined Python Parser for 4C input files
 Author: FourCIPP Authors
 License: The MIT License (MIT)
@@ -24,6 +24,8 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
+Project-URL: Repository, https://github.com/4C-multiphysics/fourcipp/
+Project-URL: Issues, https://github.com/4C-multiphysics/fourcipp/issues/
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -42,10 +44,13 @@ Dynamic: license-file
 
 <p align="center">
   <picture>
+    <source
+      srcset="https://raw.githubusercontent.com/4C-multiphysics/fourcipp/refs/heads/main/docs/assets/fourcipp_logo_white.svg"
+      media="(prefers-color-scheme: dark)">
     <img
-      src="docs/assets/fourcipp_logo_black.svg"
+      src="https://raw.githubusercontent.com/4C-multiphysics/fourcipp/refs/heads/main/docs/assets/fourcipp_logo_black.svg"
       width="300"
-      title="FourCIPP logo"
+      title="FourCIPP"
       alt="FourCIPP logo">
   </picture>
 </p>
@@ -54,41 +59,89 @@ FourCIPP (**FourC** **I**nput **P**ython **P**arser) holds a Python Parser to si
 
 ## Overview <!-- omit from toc -->
 - [Installation](#installation)
+  - [Python Environment](#python-environment)
+  - [Installation from PyPI](#installation-from-pypi)
+  - [Installation from Github (most recent version)](#installation-from-github-most-recent-version)
+  - [Installation from source](#installation-from-source)
 - [Quickstart example](#quickstart-example)
 - [Configuration](#configuration)
 - [Developing FourCIPP](#developing-fourcipp)
 - [Dependency Management](#dependency-management)
 - [License](#license)
 
+## Installation
 
+### Python Environment
 
-## Installation
+FourCIPP is a Python project supporting Python versions 3.10 - 3.13. To use FourCIPP it is recommended to install it into a virtual Python environment such as [Conda](https://anaconda.org/anaconda/conda)/[Miniforge](https://conda-forge.org/download/) or [venv](https://docs.python.org/3/library/venv.html).
+
+An exemplary [Conda](https://anaconda.org/anaconda/conda)/[Miniforge](https://conda-forge.org/download/) environment can be created and loaded with
+
+```bash
+# Create the environment (this only has to be done once)
+conda create -n fourcipp python=3.13
+# Activate the environment
+conda activate fourcipp
+```
+
+To now install FourCIPP different ways exist.
+
+### Installation from PyPI
+
+FourCIPP is published on [PyPI](https://pypi.org/project/FourCIPP/) as a universal wheel, meaning you can install it on Windows, Linux and macOS with:
+
+```bash
+pip install fourcipp
+```
+
+or a specific version with:
+
+```bash
+pip install fourcipp==0.28.0
+```
+
+### Installation from Github (most recent version)
+
+Additionally, the latest `main` version of FourCIPP can be installed directly from Github via:
+
+```bash
+pip install git+https://github.com/4C-multiphysics/fourcipp.git@main
+```
+
+### Installation from source
 
-For a quick and easy start an Anaconda/Miniconda environment is highly recommended. Other ways to install FourCIPP are possible but here the installation procedure is explained based on a conda install. After installing Anaconda/Miniconda
-execute the following steps:
+If you intend on developing FourCIPP it is crucial to install FourCIPP from source, i.e., cloning the repository from Github. You can then either install it in a non-editable or editable fashion.
+
+- Install all requirements without fixed versions in a non-editable fashion via:
 
-- Create a new Anaconda environment:
   ```bash
-  conda create -n fourcipp python=3.12
+  # located at the root of the repository
+  pip install .
   ```
 
-- Activate your newly created environment:
+  and without fixed versions in an editable fashion via:
+
   ```bash
-  conda activate fourcipp
+  # located at the root of the repository
+  pip install -e .
   ```
 
-- Install all requirements without fixed versions via:
-  ```
-  pip install .
-  ```
   > Note: This is the default behavior. This allows to use fourcipp within other projects without version conflicts.
 
-- Install all requirements with fixed versions with:
-  ```
+- Alternatively, you can install all requirements with fixed versions in a non-editable fashion with:
+
+  ```bash
   pip install .[safe]
   ```
 
-Now you are up and running 🎉
+  and with fixed versions in an editable fashion via:
+
+  ```bash
+  # located at the root of the repository
+  pip install -e .[safe]
+  ```
+
+Once installed, FourCIPP is ready to be used 🎉
 
 ## Quickstart example
 <!--example, do not remove this comment-->
@@ -141,14 +194,15 @@ and select it using the `profile` entry.
 
 ## Developing FourCIPP
 
-If you plan on actively developing FourCIPP it is advisable to install in editable mode with the development requirements like
+If you plan on actively developing FourCIPP it is advisable to install in editable mode with the additional developer requirements like
 
 ```bash
 pip install -e .[dev]
 ```
 
-You can install the pre-commit hook with:
-```
+> Note: The developer requirements can also be installed in non-editable installs. Finally, you can install the pre-commit hook with:
+
+```bash
 pre-commit install
 ```
 

{fourcipp-0.29.0.dist-info → fourcipp-1.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 fourcipp/__init__.py,sha256=4pz7DVXErSbUcLqPTaHnQfdJzKkpfZDivBqbHbTgpRE,1388
 fourcipp/fourc_input.py,sha256=4ZcaD5NQVqPqsUaUCap0UFLn80QboXSbrvWk1qd7yTU,21260
-fourcipp/version.py,sha256=HVwqojcoXKaAY41nP0Jzb2D4AuEjJK_m-opYVEhFX9w,706
+fourcipp/version.py,sha256=ePNVzJOkxR8FY5bezqKQ_fgBRbzH1G7QTaRDHvGQRAY,704
 fourcipp/config/4C_metadata.yaml,sha256=r0tDcaRhHdEPu7ex7NvTFuoAiSuASdO6NdL4t7ms2y4,11826453
 fourcipp/config/4C_schema.json,sha256=Lk9eWjvR5j2Mq3qlRsWWZMXYvd9OVOYZ_JNhDoxJLhk,16343600
 fourcipp/config/config.yaml,sha256=n2c2a6E4HKfAdNWOQz1kLUuf5p4NLxIddaAi2t5eM38,460
@@ -20,9 +20,9 @@ fourcipp/utils/not_set.py,sha256=04C_3axe2cupBYgfpgDAcGs1zHVzG3I58UGO58TH05A,201
 fourcipp/utils/typing.py,sha256=8iX9PuKe8B1WJ3vEjiM5ZfefvgYnaZDiSdB7Nx9SrVw,1625
 fourcipp/utils/validation.py,sha256=FejHOj1MddaU7gEpMN-f8Mz3rYjflakd1qcsKnctHqA,5292
 fourcipp/utils/yaml_io.py,sha256=fPJiIMVzVoHX97LFynGxmQ2PKQsUAb3GIBDWvkPfftI,3477
-fourcipp-0.29.0.dist-info/licenses/LICENSE,sha256=lkSOHdH9IZ8c3Vnz0fFjqls1cRlmLADBP8QEIwUlH3o,1082
-fourcipp-0.29.0.dist-info/METADATA,sha256=sJ5r9T1oZD282fzVNfuxStFW_Jqv8DmGxCKP2XaWDkA,5810
-fourcipp-0.29.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fourcipp-0.29.0.dist-info/entry_points.txt,sha256=44XBG4bwhuq1EwOZ0U055HYP8_qN6_d30ecVsa5Igng,53
-fourcipp-0.29.0.dist-info/top_level.txt,sha256=oZ6jgFFmvi157VwGUEFuKT3D8oS5mOkpOVx8zZURZrQ,9
-fourcipp-0.29.0.dist-info/RECORD,,
+fourcipp-1.1.0.dist-info/licenses/LICENSE,sha256=lkSOHdH9IZ8c3Vnz0fFjqls1cRlmLADBP8QEIwUlH3o,1082
+fourcipp-1.1.0.dist-info/METADATA,sha256=xSrEX3PHqiOLeizFCLaXvTFOYzymi9hotkdIcY6n7Fc,7967
+fourcipp-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fourcipp-1.1.0.dist-info/entry_points.txt,sha256=44XBG4bwhuq1EwOZ0U055HYP8_qN6_d30ecVsa5Igng,53
+fourcipp-1.1.0.dist-info/top_level.txt,sha256=oZ6jgFFmvi157VwGUEFuKT3D8oS5mOkpOVx8zZURZrQ,9
+fourcipp-1.1.0.dist-info/RECORD,,