floodmodeller-api 0.4.2.post1__tar.gz → 0.4.4__tar.gz

{floodmodeller_api-0.4.2.post1 → floodmodeller_api-0.4.4}/LICENSE.txt

@@ -1,13 +1,13 @@
-Flood Modeller Python API
-Copyright (C) 2023 Jacobs U.K. Limited
-
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 
-as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 
-of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details. 
-
-You should have received a copy of the GNU General Public License along with this program.  If not, see https://www.gnu.org/licenses/.
-
-If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following 
-address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
+Flood Modeller Python API
+Copyright (C) 2024 Jacobs U.K. Limited
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 
+as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 
+of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details. 
+
+You should have received a copy of the GNU General Public License along with this program.  If not, see https://www.gnu.org/licenses/.
+
+If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following 
+address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.

{floodmodeller_api-0.4.2.post1 → floodmodeller_api-0.4.4}/MANIFEST.in

@@ -1,8 +1,10 @@
-include license.txt
-include code-of-conduct.md
-include requirements.txt
-include floodmodeller_api/test/test_data/*
-include floodmodeller_api/toolbox/gui/*
-recursive-include floodmodeller_api *.dll
-exclude sample_code/*
-
+include license.txt
+include code-of-conduct.md
+include requirements.txt
+include floodmodeller_api/test/test_data/*
+include floodmodeller_api/toolbox/gui/*
+recursive-include floodmodeller_api *.dll
+recursive-include floodmodeller_api *.so
+recursive-include floodmodeller_api *.so.5
+exclude sample_code/*
+

{floodmodeller_api-0.4.2.post1 → floodmodeller_api-0.4.4}/PKG-INFO

@@ -1,82 +1,85 @@
-Metadata-Version: 2.1
-Name: floodmodeller_api
-Version: 0.4.2.post1
-Summary: Extends the functionality of Flood Modeller to python users
-Author: Jacobs
-Author-email: joe.pierce@jacobs.com
-License: GNU General Public License V3. Copyright (C) 2023 Jacobs U.K. Limited.
-Project-URL: API Documentation, https://api.floodmodeller.com/api/
-Project-URL: Flood Modeller Homepage, https://www.floodmodeller.com/
-Project-URL: Contact & Support, https://www.floodmodeller.com/contact
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: pandas<3,>1
-Requires-Dist: lxml==4.*
-Requires-Dist: tqdm==4.*
-Requires-Dist: pytest<8,>4
-Requires-Dist: pytest-mock==3.*
-
-![FM Logo](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/_static/flood-modeller-logo-hero-image.png)
-
-
-[![PyPI Latest Release](https://img.shields.io/pypi/v/floodmodeller-api.svg)](https://pypi.org/project/floodmodeller-api/)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/People-Places-Solutions/floodmodeller-api/blob/main/LICENSE.txt)
-![Unit Tests](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_tests.yml/badge.svg)
-![Lint](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_linters.yml/badge.svg)
-[![Downloads](https://static.pepy.tech/personalized-badge/floodmodeller-api?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/floodmodeller-api)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-
-
-# Flood Modeller Python API
-[![Try in GitHub Codespaces!](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=39-try-api-link&repo=473959586&machine=basicLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestEurope)
-
-This python package is designed to be used in conjunction with your installation of Flood Modeller to provide users with a set of tools to extend the capabilities of Flood Modeller and build into automated workflows.
-
-![API Overview](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/getting_started/api_overview_small.png)
-
-## Installation
-You can install the floodmodeller_api package from PyPI with the following command:
-
-```
-pip install floodmodeller-api
-```
-
-Python 3.9 or greater is required.
-
-Once you have installed floodmodeller_api to your python environment, you can import the package with:
-
-```python
-import floodmodeller_api  # imports the full package
-from floodmodeller_api import DAT, ZZN, IEF, IED  # imports individual classes (recommended)
-```
-## How to use
-
-The best place to start is to go directly to the [Flood Modeller Python API Documentation](https://api.floodmodeller.com/api/)
-
-The Flood Modeller Python API is designed for users already familiar with both Flood Modeller and Python. The API is built up using distinct python classes for each of the key Flood Modeller file formats as well as key themes. The purpose of the API is not to provide ready-to-use tools for specific tasks, as there is an extensive set of tools already provided within Flood Modeller, many of which can be called from both within and outside of the Flood Modeller software. **Instead, this API provides the building blocks for users to build their own custom workflows and tools which can integrate seamlessly with Flood Modeller.**
-
-## [Show and Tell](https://github.com/People-Places-Solutions/floodmodeller-api/discussions) 
-In the spirit of open source, we encourage you to share any interesting scripts or tools you have developed using the Flood Modeller Python API. 
-To do this, please get involved [in the discussions section here](https://github.com/People-Places-Solutions/floodmodeller-api/discussions). This
-is also a great place to explore different ways that people have used the API.
-
---------------------
-
-### Youtube mini tutorials
-These videos give you a quick overview of some of the basics of using the Flood Modeller API
-
-**Running a simulation**
-
-<a href="https://www.youtube.com/watch?v=WfCNkC44shI?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/253010465-8a714e5b-9364-4073-9af5-679dab0a8249.png" width="400"></a>
-
-**Using the codespace**
-
-<a href="https://www.youtube.com/watch?v=BWV3A7R0fbM?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257823093-545e0b61-4252-4ed3-8870-405fa869461d.png" width="400"></a>
-
-**Extract ReFH2 csv data into IEDs and QTBDYs**
-
-<a href="https://www.youtube.com/watch?v=E9JMQ2DKr0c?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257824500-39c991cd-8bad-4e08-bd39-0f26981d173b.png" width="400"></a>
-
-
-
+Metadata-Version: 2.1
+Name: floodmodeller_api
+Version: 0.4.4
+Summary: Extends the functionality of Flood Modeller to python users
+Author: Jacobs
+Author-email: joe.pierce@jacobs.com
+License: GNU General Public License V3. Copyright (C) 2024 Jacobs U.K. Limited.
+Project-URL: API Documentation, https://api.floodmodeller.com/api/
+Project-URL: Flood Modeller Homepage, https://www.floodmodeller.com/
+Project-URL: Contact & Support, https://www.floodmodeller.com/contact
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: pandas<3,>1
+Requires-Dist: lxml==5.*
+Requires-Dist: tqdm==4.*
+Requires-Dist: pytest<8,>4
+Requires-Dist: pytest-mock==3.*
+Requires-Dist: shapely==2.*
+Requires-Dist: scipy==1.*
+Requires-Dist: freezegun==1.*
+
+![FM Logo](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/_static/flood-modeller-logo-hero-image.png)
+
+
+[![PyPI Latest Release](https://img.shields.io/pypi/v/floodmodeller-api.svg)](https://pypi.org/project/floodmodeller-api/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/People-Places-Solutions/floodmodeller-api/blob/main/LICENSE.txt)
+![Unit Tests](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_tests.yml/badge.svg)
+![Lint](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_linters.yml/badge.svg)
+[![Downloads](https://static.pepy.tech/personalized-badge/floodmodeller-api?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/floodmodeller-api)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+
+# Flood Modeller Python API
+[![Try in GitHub Codespaces!](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&repo=473959586&quickstart=1)
+
+This python package is designed to be used in conjunction with your installation of Flood Modeller to provide users with a set of tools to extend the capabilities of Flood Modeller and build into automated workflows.
+
+![API Overview](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/getting_started/api_overview_small.png)
+
+## Installation
+You can install the floodmodeller_api package from PyPI with the following command:
+
+```
+pip install floodmodeller-api
+```
+
+Python 3.9 or greater is required.
+
+Once you have installed floodmodeller_api to your python environment, you can import the package with:
+
+```python
+import floodmodeller_api  # imports the full package
+from floodmodeller_api import DAT, ZZN, IEF, IED  # imports individual classes (recommended)
+```
+## How to use
+
+The best place to start is to go directly to the [Flood Modeller Python API Documentation](https://api.floodmodeller.com/api/)
+
+The Flood Modeller Python API is designed for users already familiar with both Flood Modeller and Python. The API is built up using distinct python classes for each of the key Flood Modeller file formats as well as key themes. The purpose of the API is not to provide ready-to-use tools for specific tasks, as there is an extensive set of tools already provided within Flood Modeller, many of which can be called from both within and outside of the Flood Modeller software. **Instead, this API provides the building blocks for users to build their own custom workflows and tools which can integrate seamlessly with Flood Modeller.**
+
+## [Show and Tell](https://github.com/People-Places-Solutions/floodmodeller-api/discussions) 
+In the spirit of open source, we encourage you to share any interesting scripts or tools you have developed using the Flood Modeller Python API. 
+To do this, please get involved [in the discussions section here](https://github.com/People-Places-Solutions/floodmodeller-api/discussions). This
+is also a great place to explore different ways that people have used the API.
+
+--------------------
+
+### Youtube mini tutorials
+These videos give you a quick overview of some of the basics of using the Flood Modeller API
+
+**Running a simulation**
+
+<a href="https://www.youtube.com/watch?v=WfCNkC44shI?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/253010465-8a714e5b-9364-4073-9af5-679dab0a8249.png" width="400"></a>
+
+**Using the codespace**
+
+<a href="https://www.youtube.com/watch?v=BWV3A7R0fbM?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257823093-545e0b61-4252-4ed3-8870-405fa869461d.png" width="400"></a>
+
+**Extract ReFH2 csv data into IEDs and QTBDYs**
+
+<a href="https://www.youtube.com/watch?v=E9JMQ2DKr0c?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257824500-39c991cd-8bad-4e08-bd39-0f26981d173b.png" width="400"></a>
+
+
+

{floodmodeller_api-0.4.2.post1 → floodmodeller_api-0.4.4}/README.md

@@ -1,64 +1,64 @@
-![FM Logo](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/_static/flood-modeller-logo-hero-image.png)
-
-
-[![PyPI Latest Release](https://img.shields.io/pypi/v/floodmodeller-api.svg)](https://pypi.org/project/floodmodeller-api/)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/People-Places-Solutions/floodmodeller-api/blob/main/LICENSE.txt)
-![Unit Tests](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_tests.yml/badge.svg)
-![Lint](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_linters.yml/badge.svg)
-[![Downloads](https://static.pepy.tech/personalized-badge/floodmodeller-api?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/floodmodeller-api)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-
-
-# Flood Modeller Python API
-[![Try in GitHub Codespaces!](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=39-try-api-link&repo=473959586&machine=basicLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestEurope)
-
-This python package is designed to be used in conjunction with your installation of Flood Modeller to provide users with a set of tools to extend the capabilities of Flood Modeller and build into automated workflows.
-
-![API Overview](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/getting_started/api_overview_small.png)
-
-## Installation
-You can install the floodmodeller_api package from PyPI with the following command:
-
-```
-pip install floodmodeller-api
-```
-
-Python 3.9 or greater is required.
-
-Once you have installed floodmodeller_api to your python environment, you can import the package with:
-
-```python
-import floodmodeller_api  # imports the full package
-from floodmodeller_api import DAT, ZZN, IEF, IED  # imports individual classes (recommended)
-```
-## How to use
-
-The best place to start is to go directly to the [Flood Modeller Python API Documentation](https://api.floodmodeller.com/api/)
-
-The Flood Modeller Python API is designed for users already familiar with both Flood Modeller and Python. The API is built up using distinct python classes for each of the key Flood Modeller file formats as well as key themes. The purpose of the API is not to provide ready-to-use tools for specific tasks, as there is an extensive set of tools already provided within Flood Modeller, many of which can be called from both within and outside of the Flood Modeller software. **Instead, this API provides the building blocks for users to build their own custom workflows and tools which can integrate seamlessly with Flood Modeller.**
-
-## [Show and Tell](https://github.com/People-Places-Solutions/floodmodeller-api/discussions) 
-In the spirit of open source, we encourage you to share any interesting scripts or tools you have developed using the Flood Modeller Python API. 
-To do this, please get involved [in the discussions section here](https://github.com/People-Places-Solutions/floodmodeller-api/discussions). This
-is also a great place to explore different ways that people have used the API.
-
---------------------
-
-### Youtube mini tutorials
-These videos give you a quick overview of some of the basics of using the Flood Modeller API
-
-**Running a simulation**
-
-<a href="https://www.youtube.com/watch?v=WfCNkC44shI?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/253010465-8a714e5b-9364-4073-9af5-679dab0a8249.png" width="400"></a>
-
-**Using the codespace**
-
-<a href="https://www.youtube.com/watch?v=BWV3A7R0fbM?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257823093-545e0b61-4252-4ed3-8870-405fa869461d.png" width="400"></a>
-
-**Extract ReFH2 csv data into IEDs and QTBDYs**
-
-<a href="https://www.youtube.com/watch?v=E9JMQ2DKr0c?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257824500-39c991cd-8bad-4e08-bd39-0f26981d173b.png" width="400"></a>
-
-
-
+![FM Logo](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/_static/flood-modeller-logo-hero-image.png)
+
+
+[![PyPI Latest Release](https://img.shields.io/pypi/v/floodmodeller-api.svg)](https://pypi.org/project/floodmodeller-api/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/People-Places-Solutions/floodmodeller-api/blob/main/LICENSE.txt)
+![Unit Tests](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_tests.yml/badge.svg)
+![Lint](https://github.com/People-Places-Solutions/floodmodeller-api/actions/workflows/run_linters.yml/badge.svg)
+[![Downloads](https://static.pepy.tech/personalized-badge/floodmodeller-api?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/floodmodeller-api)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+
+# Flood Modeller Python API
+[![Try in GitHub Codespaces!](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&repo=473959586&quickstart=1)
+
+This python package is designed to be used in conjunction with your installation of Flood Modeller to provide users with a set of tools to extend the capabilities of Flood Modeller and build into automated workflows.
+
+![API Overview](https://raw.githubusercontent.com/People-Places-Solutions/floodmodeller-api/main/docs/source/getting_started/api_overview_small.png)
+
+## Installation
+You can install the floodmodeller_api package from PyPI with the following command:
+
+```
+pip install floodmodeller-api
+```
+
+Python 3.9 or greater is required.
+
+Once you have installed floodmodeller_api to your python environment, you can import the package with:
+
+```python
+import floodmodeller_api  # imports the full package
+from floodmodeller_api import DAT, ZZN, IEF, IED  # imports individual classes (recommended)
+```
+## How to use
+
+The best place to start is to go directly to the [Flood Modeller Python API Documentation](https://api.floodmodeller.com/api/)
+
+The Flood Modeller Python API is designed for users already familiar with both Flood Modeller and Python. The API is built up using distinct python classes for each of the key Flood Modeller file formats as well as key themes. The purpose of the API is not to provide ready-to-use tools for specific tasks, as there is an extensive set of tools already provided within Flood Modeller, many of which can be called from both within and outside of the Flood Modeller software. **Instead, this API provides the building blocks for users to build their own custom workflows and tools which can integrate seamlessly with Flood Modeller.**
+
+## [Show and Tell](https://github.com/People-Places-Solutions/floodmodeller-api/discussions) 
+In the spirit of open source, we encourage you to share any interesting scripts or tools you have developed using the Flood Modeller Python API. 
+To do this, please get involved [in the discussions section here](https://github.com/People-Places-Solutions/floodmodeller-api/discussions). This
+is also a great place to explore different ways that people have used the API.
+
+--------------------
+
+### Youtube mini tutorials
+These videos give you a quick overview of some of the basics of using the Flood Modeller API
+
+**Running a simulation**
+
+<a href="https://www.youtube.com/watch?v=WfCNkC44shI?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/253010465-8a714e5b-9364-4073-9af5-679dab0a8249.png" width="400"></a>
+
+**Using the codespace**
+
+<a href="https://www.youtube.com/watch?v=BWV3A7R0fbM?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257823093-545e0b61-4252-4ed3-8870-405fa869461d.png" width="400"></a>
+
+**Extract ReFH2 csv data into IEDs and QTBDYs**
+
+<a href="https://www.youtube.com/watch?v=E9JMQ2DKr0c?vq=1080p" target="_blank"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/56606086/257824500-39c991cd-8bad-4e08-bd39-0f26981d173b.png" width="400"></a>
+
+
+

{floodmodeller_api-0.4.2.post1 → floodmodeller_api-0.4.4}/floodmodeller_api/__init__.py

@@ -1,9 +1,8 @@
-from .dat import DAT
-from .ied import IED
-from .ief import IEF
-from .inp import INP
-from .logs import LF1, LF2
-from .util import open_docs
-from .version import __version__
-from .xml2d import XML2D
-from .zzn import ZZN
+from .dat import DAT
+from .ied import IED
+from .ief import IEF
+from .inp import INP
+from .logs import LF1, LF2
+from .version import __version__
+from .xml2d import XML2D
+from .zzn import ZZN