nfdata 0.1.0__tar.gz → 0.2.0__tar.gz

nfdata-0.2.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, UK Centre for Ecology & Hydrology
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{nfdata-0.1.0 → nfdata-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: nfdata
-Version: 0.1.0
+Version: 0.2.0
 Summary: Compile and edit input data for the NanoFASE model
 License: BSD-3-Clause
 Author: Sam Harrison
@@ -10,10 +10,12 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: Pint (>=0.24.1,<0.25.0)
 Requires-Dist: f90nml (>=1.4.4,<2.0.0)
 Requires-Dist: geopandas (>=1.0.0,<2.0.0)
-Requires-Dist: netCDF4 (>=1.7.1.post1,<2.0.0)
+Requires-Dist: netcdf4 (>=1.7.1.post1,<2.0.0)
 Requires-Dist: numpy (>=2.0.0,<3.0.0)
 Requires-Dist: pandas (>=2.2.2,<3.0.0)
 Requires-Dist: rasterio (>=1.3.10,<2.0.0)
@@ -28,23 +30,41 @@ The NanoFASE Data module is a set of scripts to compile and edit input data for
 
 [See the NanoFASE documentation for full documentation](https://nerc-ceh.github.io/nanofase/users/nanofase-data.html).
 
-*Still in development. Use with caution!*
-
 ## Getting started
 
-The easiest way to get started is to create a Conda environment using the provided [environment.yaml](./environment.yaml) file:
+The package is available on [PyPI](https://pypi.org/project/nfdata/) or [Conda](https://anaconda.org/samharrison7/nfdata), and the easiest way to use the package is to install one of these using Pixi, Conda/Mamba or Pip.
+
+Conda:
+
+```console
+$ conda install -c samharrison7 nfdata
+```
+
+Mamba:
+```console
+$ mamba install -c samharrison7 nfdata
+```
 
-```shell script
-$ conda env create -f environment.yaml
-$ activate nanofase-data
+Pip:
+```console
+$ pip install nfdata
 ```
 
-If you don't want to use Conda, then this [environment.yaml](./environment.yaml) file lists the packages that need to be installed.
+Pixi (global):
+```console
+$ pixi global install -c samharrison7 nfdata
+```
+
+Pixi (project):
+```console
+$ pixi project channel add samharrison7
+$ pixi add nfdata
+```
 
 ## Usage
 
 ```
-usage: nanofase_data.py [-h] [--output OUTPUT] {create,edit,constants} file
+usage: nfdata [-h] [--output OUTPUT] {create,edit,constants} file
 
 Compile or edit data for the NanoFASE model.
 
@@ -66,8 +86,8 @@ optional arguments:
 
 Specifying the "create" option compiles a new NetCDF dataset and Fortran namelist constant file:
 
-```shell script
-$ python nanofase_data.py create /path/to/config.create.yaml
+```console
+$ nfdata create /path/to/config.create.yaml
 ```
 
 An annotated example config file is given: [`config.create.example.yaml`](config.create.example.yaml). The file is quite self-explanatory, but a few further explanations are provided in [this document](docs/config.md).
@@ -78,8 +98,8 @@ The two files will be output to the paths specified in the config file.
 
 To edit an existing NetCDF dataset, specify the "edit" option:
 
-```shell script
-$ python nanofase_data.py edit /path/to/config.edit.yaml
+```console
+$ nfdata edit /path/to/config.edit.yaml
 ```
 
 An annotated example config file is given: [`config.edit.example.yaml`](config.edit.example.yaml). This is similar (but not identical) in format to the creation config file, except only those variables you with to edit should be specified (all other variables are left as-is).
@@ -92,8 +112,8 @@ The Fortran namelist file cannot be edited using this method and you should inst
 
 To simply convert a constants YAML file to a Fortran namelist file, you can use the `constants` option:
 
-```shell script
-$ python nanofase_data.py constants /path/to/constants.yaml -o /path/to/constants.nml
+```console
+$ nfdata constants /path/to/constants.yaml -o /path/to/constants.nml
 ```
 
 No config file is required. The location of the newly created constants file is given by the `-o` or `--output` argument.
@@ -102,3 +122,4 @@ No config file is required. The location of the newly created constants file is
 - For the moment, all rasters must be the same CRS as the `flow_dir` raster, and this must be a projected raster. We recommend ESPG:27700 (British National Grid). In addition, all rasters except for `land_use` must be the same resolution as `flow_dir`. They can cover a large geographical region and the module will automatically clip them to the correct size.
 - Support for different file types is a bit sporadic at the moment. I suggest sticking the raster files for spatial variables, raster or CSV files for spatiotemporal variables (with 1 file per timestep for raster files) and shapefiles for point sources. You will trigger errors if you use an unsupported file.
 - Example input data files are given in `data.example/thames_tio2_2015/`. Running the model using the example config files uses these data. 
+

{nfdata-0.1.0 → nfdata-0.2.0}/README.md

@@ -4,23 +4,41 @@ The NanoFASE Data module is a set of scripts to compile and edit input data for
 
 [See the NanoFASE documentation for full documentation](https://nerc-ceh.github.io/nanofase/users/nanofase-data.html).
 
-*Still in development. Use with caution!*
-
 ## Getting started
 
-The easiest way to get started is to create a Conda environment using the provided [environment.yaml](./environment.yaml) file:
+The package is available on [PyPI](https://pypi.org/project/nfdata/) or [Conda](https://anaconda.org/samharrison7/nfdata), and the easiest way to use the package is to install one of these using Pixi, Conda/Mamba or Pip.
+
+Conda:
 
-```shell script
-$ conda env create -f environment.yaml
-$ activate nanofase-data
+```console
+$ conda install -c samharrison7 nfdata
 ```
 
-If you don't want to use Conda, then this [environment.yaml](./environment.yaml) file lists the packages that need to be installed.
+Mamba:
+```console
+$ mamba install -c samharrison7 nfdata
+```
+
+Pip:
+```console
+$ pip install nfdata
+```
+
+Pixi (global):
+```console
+$ pixi global install -c samharrison7 nfdata
+```
+
+Pixi (project):
+```console
+$ pixi project channel add samharrison7
+$ pixi add nfdata
+```
 
 ## Usage
 
 ```
-usage: nanofase_data.py [-h] [--output OUTPUT] {create,edit,constants} file
+usage: nfdata [-h] [--output OUTPUT] {create,edit,constants} file
 
 Compile or edit data for the NanoFASE model.
 
@@ -42,8 +60,8 @@ optional arguments:
 
 Specifying the "create" option compiles a new NetCDF dataset and Fortran namelist constant file:
 
-```shell script
-$ python nanofase_data.py create /path/to/config.create.yaml
+```console
+$ nfdata create /path/to/config.create.yaml
 ```
 
 An annotated example config file is given: [`config.create.example.yaml`](config.create.example.yaml). The file is quite self-explanatory, but a few further explanations are provided in [this document](docs/config.md).
@@ -54,8 +72,8 @@ The two files will be output to the paths specified in the config file.
 
 To edit an existing NetCDF dataset, specify the "edit" option:
 
-```shell script
-$ python nanofase_data.py edit /path/to/config.edit.yaml
+```console
+$ nfdata edit /path/to/config.edit.yaml
 ```
 
 An annotated example config file is given: [`config.edit.example.yaml`](config.edit.example.yaml). This is similar (but not identical) in format to the creation config file, except only those variables you with to edit should be specified (all other variables are left as-is).
@@ -68,8 +86,8 @@ The Fortran namelist file cannot be edited using this method and you should inst
 
 To simply convert a constants YAML file to a Fortran namelist file, you can use the `constants` option:
 
-```shell script
-$ python nanofase_data.py constants /path/to/constants.yaml -o /path/to/constants.nml
+```console
+$ nfdata constants /path/to/constants.yaml -o /path/to/constants.nml
 ```
 
 No config file is required. The location of the newly created constants file is given by the `-o` or `--output` argument.
@@ -77,4 +95,4 @@ No config file is required. The location of the newly created constants file is
 ### Tips
 - For the moment, all rasters must be the same CRS as the `flow_dir` raster, and this must be a projected raster. We recommend ESPG:27700 (British National Grid). In addition, all rasters except for `land_use` must be the same resolution as `flow_dir`. They can cover a large geographical region and the module will automatically clip them to the correct size.
 - Support for different file types is a bit sporadic at the moment. I suggest sticking the raster files for spatial variables, raster or CSV files for spatiotemporal variables (with 1 file per timestep for raster files) and shapefiles for point sources. You will trigger errors if you use an unsupported file.
-- Example input data files are given in `data.example/thames_tio2_2015/`. Running the model using the example config files uses these data. 
+- Example input data files are given in `data.example/thames_tio2_2015/`. Running the model using the example config files uses these data. 

{nfdata-0.1.0 → nfdata-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nfdata"
-version = "0.1.0"
+version = "0.2.0"
 description = "Compile and edit input data for the NanoFASE model"
 authors = ["Sam Harrison <samharrison.xg@gmail.com>"]
 license = "BSD-3-Clause"
@@ -20,7 +20,7 @@ pandas = "^2.2.2"
 geopandas = "^1.0.0"
 rasterio = "^1.3.10"
 "ruamel.yaml" = "^0.18.6"
-netCDF4 = "^1.7.1.post1"
+netcdf4 = "^1.7.1.post1"
 shapely = "^2.0.4"
 Pint = "^0.24.1"
 f90nml = "^1.4.4"

nfdata-0.1.0/setup.py

@@ -1,46 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['nfdata']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['Pint>=0.24.1,<0.25.0',
- 'f90nml>=1.4.4,<2.0.0',
- 'geopandas>=1.0.0,<2.0.0',
- 'netCDF4>=1.7.1.post1,<2.0.0',
- 'numpy>=2.0.0,<3.0.0',
- 'pandas>=2.2.2,<3.0.0',
- 'rasterio>=1.3.10,<2.0.0',
- 'ruamel.yaml>=0.18.6,<0.19.0',
- 'shapely>=2.0.4,<3.0.0']
-
-entry_points = \
-{'console_scripts': ['nfdata = nfdata.console:run']}
-
-setup_kwargs = {
-    'name': 'nfdata',
-    'version': '0.1.0',
-    'description': 'Compile and edit input data for the NanoFASE model',
-    'long_description': '# NanoFASE Data\n\nThe NanoFASE Data module is a set of scripts to compile and edit input data for the [NanoFASE model](https://github.com/nerc-ceh/nanofase).\n\n[See the NanoFASE documentation for full documentation](https://nerc-ceh.github.io/nanofase/users/nanofase-data.html).\n\n*Still in development. Use with caution!*\n\n## Getting started\n\nThe easiest way to get started is to create a Conda environment using the provided [environment.yaml](./environment.yaml) file:\n\n```shell script\n$ conda env create -f environment.yaml\n$ activate nanofase-data\n```\n\nIf you don\'t want to use Conda, then this [environment.yaml](./environment.yaml) file lists the packages that need to be installed.\n\n## Usage\n\n```\nusage: nanofase_data.py [-h] [--output OUTPUT] {create,edit,constants} file\n\nCompile or edit data for the NanoFASE model.\n\npositional arguments:\n  {create,edit,constants}\n                        do you wish to create from scratch, edit the data or\n                        create a constants file?\n  file                  path to the config file (create/edit tasks) or\n                        constants file (constants task)\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --output OUTPUT, -o OUTPUT\n                        where to create the new constants file (for constants\n                        task)\n```\n\n### Creating a new dataset\n\nSpecifying the "create" option compiles a new NetCDF dataset and Fortran namelist constant file:\n\n```shell script\n$ python nanofase_data.py create /path/to/config.create.yaml\n```\n\nAn annotated example config file is given: [`config.create.example.yaml`](config.create.example.yaml). The file is quite self-explanatory, but a few further explanations are provided in [this document](docs/config.md).\n\nThe two files will be output to the paths specified in the config file.\n\n### Editing an existing dataset\n\nTo edit an existing NetCDF dataset, specify the "edit" option:\n\n```shell script\n$ python nanofase_data.py edit /path/to/config.edit.yaml\n```\n\nAn annotated example config file is given: [`config.edit.example.yaml`](config.edit.example.yaml). This is similar (but not identical) in format to the creation config file, except only those variables you with to edit should be specified (all other variables are left as-is).\n\nCertain variables can\'t be edited: `flow_dir`, `is_estuary`. Create a new dataset instead if you wish to change these variables.\n\nThe Fortran namelist file cannot be edited using this method and you should instead edit the file directly.\n\n### Only creating a new constants file\n\nTo simply convert a constants YAML file to a Fortran namelist file, you can use the `constants` option:\n\n```shell script\n$ python nanofase_data.py constants /path/to/constants.yaml -o /path/to/constants.nml\n```\n\nNo config file is required. The location of the newly created constants file is given by the `-o` or `--output` argument.\n\n### Tips\n- For the moment, all rasters must be the same CRS as the `flow_dir` raster, and this must be a projected raster. We recommend ESPG:27700 (British National Grid). In addition, all rasters except for `land_use` must be the same resolution as `flow_dir`. They can cover a large geographical region and the module will automatically clip them to the correct size.\n- Support for different file types is a bit sporadic at the moment. I suggest sticking the raster files for spatial variables, raster or CSV files for spatiotemporal variables (with 1 file per timestep for raster files) and shapefiles for point sources. You will trigger errors if you use an unsupported file.\n- Example input data files are given in `data.example/thames_tio2_2015/`. Running the model using the example config files uses these data. ',
-    'author': 'Sam Harrison',
-    'author_email': 'samharrison.xg@gmail.com',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'None',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.10,<4.0',
-}
-
-
-setup(**setup_kwargs)