Package: siaplotlib
SIAPLOTLIBVersion: 0.2.1Python library as part of the SIA project. Its aim is to provide an
easy to use interface for plotting oceanic data.Page of the project:https://sia-information-system.github.io/sia-websiteTable of contentInstallRequirements before installationProduction modeDevelopment modeTestsDocumentationContributionsInstallRequirements before installationThis package depends onCartopyv0.21.1,
which is a package that in order to be installed bypipneeds to have some C/C++ libraries available in
the host operating system, which it's not a problem in Linux or MacOS, but it is on Windows.
See theCartopy installation docsto see how to install required dependencies on Linux and MacOS.If you are on Windows, in order to simplify the installation of this package, we recommend to
use the pre-built Cartopy binaries distributed byconda(anaconda/miniconda). Once you haveconda, you can install Cartopy with the following command:condainstallcartopy=0.21.1Before install this package make sure you have the C/C++ library installed
on your operating system to build Cartopy, or have the pre-built binaries
installed on the environment you are going to use.Production modeYou can install this package from PyPI using:pipinstallsiaplotlibTo install the package from source code, clone the repo from GitHub and
run the following command in the package root directory
(where thepyproject.tomlfile is located):pipinstall.Seelocal installationfor details.Development modeNOTE: For development it's recommended to use an isolated environment.
You can use tools likeanaconda/miniondaorvirtualenvto create
this kind of environments. On Windows, due to the reasons exposed in theRequirements before installationsection,
we highly recommend to usecondaas environments manager. If you are on
other operating systen, you don't use conda and you decide to store the
environment in the root directory of the project, name the environment asvenvsince this name of directory is ignored by git.To install the package in development mode (--editable), run the following command
in the package root directory (where depyproject.tomlfile is located):pipinstall--editable.[dev]Seelocal installationfor details.To increase the version number, the packagebumpveris used.Read the docsto see how to use it.TestsMake sure to have the following files used to create the visualizations, you can download themhere.global-analysis-forecast-phy-001-024-GLOBAL_ANALYSIS_FORECAST_PHY_001_024-TDS-date-2022-11-13-time-10h-31m-10s-857022ms.ncglobal-analysis-forecast-phy-001-024-GLOBAL_ANALYSIS_FORECAST_PHY_001_024-TDS-date-2022-11-13-time-13h-27m-31s-211639ms-monthly.nctime-series.pngheatmap.gifOnce done, place them intmp/data/.Make sure to have installed the package, whether in production or development mode.Then go to the test directory and run the following command to start the testing module:pythontest_chart_builders.pyTests are written withunittestframework, so alternative ways of running the
test are described in itsdocumentation.DocumentationRead the documentation for this packagehere.ContributionsRules are:First ask to maintainers if the new proposed feature can be added. You can open an issue on GitHub.Document every new feature added.Add tests for each new feature.