diff --git a/.readthedocs.yml b/.readthedocs.yml index 56a1ea1..34c3539 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,7 +3,7 @@ formats: [] build: os: "ubuntu-22.04" tools: - python: "3.9" + python: "3.11" python: install: - requirements: docs/requirements.txt diff --git a/LICENCE b/LICENSE similarity index 100% rename from LICENCE rename to LICENSE diff --git a/Makefile b/Makefile index 52d27b3..25c68ca 100644 --- a/Makefile +++ b/Makefile @@ -13,18 +13,3 @@ qa: unit-tests: cd .. && python -m pytest earthkit -vv --cov=. --cov-report=$(COV_REPORT) && cd - - -type-check: - python -m mypy . - -conda-env-update: - $(CONDA) env update $(CONDAFLAGS) -f environment.yml - -docker-build: - docker build -t $(PROJECT) . - -docker-run: - docker run --rm -ti -v $(PWD):/srv $(PROJECT) - -docs-build: - cd docs && rm -fr _api && make clean && make html diff --git a/README.md b/README.md index c89beb9..9a25c5e 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@

- -

@@ -25,9 +23,7 @@ | | | | |:-------------------------:|:-------------------------:|:-------------------------:| | | | | -| | | | -| | | | -| | | | +| | | | diff --git a/docs/components_overview.rst b/docs/components_overview.rst index b020ee3..ca22437 100644 --- a/docs/components_overview.rst +++ b/docs/components_overview.rst @@ -32,19 +32,7 @@ This is the summary of the available ``earthkit`` components. - Visualisation tools and templates. - .. image:: https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-plots-light.svg :width: 180px - * - :xref:`earthkit-regrid` - - Regridding of geospatial data. - - .. image:: https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-regrid-light.svg - :width: 180px - * - :xref:`earthkit-time` - - Manipulation of dates and time for weather forecasting. - - .. image:: https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-time-light.svg - :width: 180px * - :xref:`earthkit-transforms` - Aggregation and transformation of geospatial data. - .. image:: https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-transforms-light.svg :width: 180px - * - :xref:`earthkit-workflows` - - Scheduling and execution of task graphs. - - .. image:: https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-workflows-light.svg - :width: 180px diff --git a/docs/conf.py b/docs/conf.py index 1851bc8..a58a976 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,9 +30,7 @@ else: source_branch = "main" -src_path = os.path.normpath( - os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "src") -) +src_path = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "src")) sys.path.insert(0, src_path) # Adds path to the folder _ext, where extensions are stored @@ -128,19 +126,11 @@ # clean_autodocs.py feature flags # Set to False/None to disable or soften the corresponding processing step. autodocs_delete_hidden = True # delete RST files for private/hidden modules -autodocs_replace_automodule = ( - True # replace automodule directives with autosummary tables -) -autodocs_short_display_names = ( - True # shorten toctree labels to the last module component -) -autodocs_top_level_maxdepth = ( - 1 # :maxdepth: on top-level page (None = keep sphinx-apidoc value) -) +autodocs_replace_automodule = True # replace automodule directives with autosummary tables +autodocs_short_display_names = True # shorten toctree labels to the last module component +autodocs_top_level_maxdepth = 1 # :maxdepth: on top-level page (None = keep sphinx-apidoc value) autodocs_rename_titles = False # strip " package"/" module" from RST page headings -autodocs_top_level_title = ( - "API Reference" # top-level page heading (used when rename_titles=True) -) +autodocs_top_level_title = "API Reference" # top-level page heading (used when rename_titles=True) autodocs_titlesonly = False # inject :titlesonly: into toctree directives # List of patterns, relative to source directory, that match files and diff --git a/docs/development/guidelines.rst b/docs/development/guidelines.rst index 475804a..b180b25 100644 --- a/docs/development/guidelines.rst +++ b/docs/development/guidelines.rst @@ -4,4 +4,4 @@ Development guidelines ------------------------------ Guidelines for developers to contribute to ECMWF software are explained in our -`Codex `_. \ No newline at end of file +`Codex `_. diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 594ce12..5e75988 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -21,4 +21,3 @@ Install **earthkit** with python3 (>= 3.10) and ``pip`` as follows (specific to .. conda install earthkit -c conda-forge .. This will bring in some necessary binary dependencies for you. - diff --git a/docs/index.rst b/docs/index.rst index 7b88a88..76351cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -Earthkit -========= +earthkit +======== **earthkit** is a new open-source Python project led by ECMWF, providing powerful tools for speeding up weather and climate science workflows by simplifying data access, processing, analysis, visualisation and much more. diff --git a/docs/requirements.txt b/docs/requirements.txt index 4ef695b..6d4c4b7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -7,4 +7,4 @@ sphinx_design furo nbsphinx setuptools -pyyaml \ No newline at end of file +pyyaml diff --git a/environment.yml b/environment.yml deleted file mode 100644 index 332fbb7..0000000 --- a/environment.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: earthkit -channels: -- conda-forge -- nodefaults -dependencies: -- earthkit-data>=0.17.0 -- geos -- pip: - - earthkit-geo[all]>=0.4.0 - - earthkit-hydro>=1.0.0 - - earthkit-meteo>=0.4.1 - - earthkit-plots>=0.5.1 - - earthkit-regrid>=0.5.0 - - earthkit-time>=0.1.7 - - earthkit-transforms>=0.5.0 - - earthkit-utils>=0.1.2 - - earthkit-workflows>=0.4.7 diff --git a/pyproject.toml b/pyproject.toml index c32cf75..597fce6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,11 +1,12 @@ [build-system] -requires = [ "setuptools>=61" ] +requires = [ "setuptools>=77", "setuptools-scm[toml]>=8" ] [project] name = "earthkit" description = "Toolkit for earth science workflows" readme = "README.md" -license = { text = "Apache License Version 2.0" } +license = "Apache-2.0" +license-files = [ "LICENSE" ] authors = [ { name = "European Centre for Medium-Range Weather Forecasts (ECMWF)", email = "software.support@ecmwf.int" }, ] @@ -15,7 +16,6 @@ classifiers = [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: Science/Research", - "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.10", @@ -29,13 +29,13 @@ classifiers = [ ] dynamic = [ "version" ] dependencies = [ - "earthkit-data[all]>=1.0.0rc0", - "earthkit-geo[all]>=1.0.0rc0", - "earthkit-hydro>=1.3.0rc0", - "earthkit-meteo>=1.0.0rc0", - "earthkit-plots>=1.0.0rc0", - "earthkit-transforms>=1.0.0rc0", - "earthkit-utils>=1.0.0rc0", + "earthkit-data[all]>=1rc0", + "earthkit-geo[all]>=1rc0", + "earthkit-hydro>=1.3rc0", + "earthkit-meteo>=1rc0", + "earthkit-plots>=1rc0", + "earthkit-transforms>=1rc0", + "earthkit-utils>=1rc0", ] optional-dependencies.test = [ "pytest", "pytest-forked" ] urls.Documentation = "https://earthkit.readthedocs.io/" @@ -46,6 +46,10 @@ urls.Repository = "https://github.com/ecmwf/earthkit/" [tool.setuptools] packages = [ ] +[tool.setuptools_scm] +version_file = "src/earthkit/_version.py" +local_scheme = "no-local-version" + [tool.isort] profile = "black" diff --git a/tests/environment-docs-tests.yml b/tests/environment-docs-tests.yml deleted file mode 100644 index 787e94f..0000000 --- a/tests/environment-docs-tests.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: earthkit -channels: -- conda-forge -- nodefaults -dependencies: -- pip -- sphinx -- sphinx-autoapi -- sphinx_rtd_theme -- sphinxcontrib-apidoc -- nbformat -- nbconvert -- nbsphinx -- ipykernel diff --git a/tests/environment-unit-tests.yml b/tests/environment-unit-tests.yml deleted file mode 100644 index c175768..0000000 --- a/tests/environment-unit-tests.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: earthkit -channels: -- conda-forge -- nodefaults -dependencies: -- pip -- pytest -- pytest-cov -- pytest-forked -- geos -- pip: - - earthkit-data[all]>=0.17.0 - - earthkit-geo[all]>=0.4.0 - - earthkit-meteo>=0.4.1 - - earthkit-plots>=0.5.1 - - earthkit-regrid>=0.5.0 - - earthkit-time>=0.1.7 - - earthkit-transforms>=0.5.0 - - earthkit-hydro>=1.0.0 - - earthkit-utils>=0.1.2 - - earthkit-workflows>=0.4.7