oceanval 0.1.0__tar.gz

oceanval-0.1.0/MANIFEST.in

@@ -0,0 +1,28 @@
+include MANIFEST.in
+include LICENSE
+include README.md
+include setup.py
+include requirements.txt 
+exclude .gitattributes 
+exclude build-conda-package 
+#
+#
+#graft oceanval
+#
+#
+global-exclude *.bz2
+recursive-exclude docs *
+recursive-exclude tests *
+recursive-exclude tutorials *
+recursive-exclude oceanval.egg-info *
+recursive-exclude .github *
+global-exclude docs/*
+global-exclude *.nc
+global-exclude *.sh
+global-exclude *.rst
+global-exclude *.yml
+global-exclude *.yaml
+global-exclude *.txt
+global-exclude .coveragerc
+global-exclude .gitignore
+include requirements.txt 

oceanval-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: oceanval
+Version: 0.1.0
+Summary: A Python package for ocean model validation and analysis
+Home-page: https://github.com/pmlmodelling/oceanVal
+Author: Robert Wilson
+Author-email: rwi@pml.ac.uk
+Maintainer: Robert Wilson
+Project-URL: Bug Tracker, https://github.com/pmlmodelling/oceanVal/issues
+Project-URL: Source Code, https://github.com/pmlmodelling/oceanVal
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.6.1
+Requires-Dist: xarray
+Requires-Dist: netCDF4
+Requires-Dist: hvplot
+Requires-Dist: panel
+Requires-Dist: pandas
+Requires-Dist: ncplot
+Requires-Dist: dill
+Requires-Dist: python-dateutil
+Requires-Dist: matplotlib
+Requires-Dist: jupytext
+Requires-Dist: nctoolkit>=1.1.1
+Requires-Dist: jellyfish
+Requires-Dist: geopandas
+Requires-Dist: holoviews
+Requires-Dist: plotnine
+Requires-Dist: jupyter-book==1.0.4
+Requires-Dist: seawater
+Requires-Dist: cmocean
+Requires-Dist: numpydoc
+Requires-Dist: sphinx_rtd_theme
+Requires-Dist: nbsphinx
+Requires-Dist: molmass
+Requires-Dist: fiona
+Provides-Extra: complete
+Requires-Dist: geoviews; extra == "complete"
+Requires-Dist: rioxarray; extra == "complete"
+Requires-Dist: cfchecker; extra == "complete"
+Requires-Dist: geocube; extra == "complete"
+Requires-Dist: geopandas; extra == "complete"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: maintainer
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+
+**oceanVal** is a Python package designed to automate the process of validating ocean models against observational datasets. It provides a suite of tools to facilitate the comparison of model outputs with various observational data sources, enabling researchers to assess model performance effectively. 
+
+Core abilities of oceanVal include:
+
+  - Matching model output variables to observational datasets 
+  - Assesing spatial and temporal performance of ocean models 
+  - Assessing model skill using a variety of statistical metrics 
+  - Asssessing extent of model biases 
+  - Generating comprehensive validation reports in html format
+
+

oceanval-0.1.0/README.md

@@ -0,0 +1,66 @@
+[![Documentation Status](https://readthedocs.org/projects/oceanval/badge/?version=latest)](https://oceanval.readthedocs.io/en/latest/?badge=latest)
+
+# oceanVal 
+Marine ecosystem model validation made easy in Python
+
+
+# Installation 
+
+First, clone this directory:
+
+```sh
+git clone https://github.com/pmlmodelling/oceanval.git
+```
+
+Then move to this directory.
+
+```sh
+cd oceanval
+```
+
+
+Second, set up a conda environment. If you want the envionment to called something other than `oceanval`, you can change the name in the oceanval.yml file. 
+
+```sh
+conda env create -f oceanval.yml
+```
+
+
+
+Activate this environment.
+
+```sh
+conda activate oceanval
+```
+
+Now, sometimes R package installs go wrong in conda. Run the following command to ensure Rcpp is installed correctly.
+
+```sh
+Rscript -e "install.packages('Rcpp', repos = 'https://cloud.r-project.org/')"
+```
+
+Now, install the package.
+
+```sh
+pip install .
+
+```sh
+conda activate oceanval
+```
+
+
+Now, install the package.
+
+```sh
+pip install .
+
+```
+Alternatively, install the conda environment and package using the following commands:
+
+```sh
+    conda env create --name oceanval -f https://raw.githubusercontent.com/pmlmodelling/oceanval/main/oceanval.yml
+    conda activate oceanval​
+    pip install git+https://github.com/pmlmodelling/oceanval.git​
+```
+
+A website and user guide is available at: https://oceanval.readthedocs.io/en/latest/.