diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index d027af6..777e1fd 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -1,12 +1,9 @@ Contributing ============ -.. warning:: - This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development. - We welcome contributions from the community! There are several ways you can contribute to both the Cryosphere Community Datapool (CCD) and **ccdtools** projects: -1. **Reporting Issues**: If you encounter any bugs or have suggestions for improvements, please open an issue on our `GitHub repository `_. +1. **Reporting Issues**: If you encounter any bugs or have suggestions for improvements, please open an `issue on our GitHub repository `_. 2. **Submitting Pull Requests**: If you would like to contribute code, please fork the repository, make your changes, and submit a pull request. Be sure to follow our coding standards and include tests for any new features or bug fixes. diff --git a/docs/source/index.rst b/docs/source/index.rst index 1d13fd6..240f7ff 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,7 +14,7 @@ The `CCD` has been designed as an open-access and freely available cryospheric d variety of datasets commonly used to parameterise ice sheet models. The `CCD` is hosted on the National Computational Infrastructure (NCI) Gadi supercomputer within project `av17`. -This documentation describes the associated Python interface **ccdtools** developed by `ACCESS-NRI `_ that provides seamless +This documentation describes the `CCD` Python interface **ccdtools** developed by `ACCESS-NRI `_ that provides seamless access to the data located within the `CCD`. The **ccdtools** library offers an intuitive interface for discovering, accessing, and analysing diverse data sources including satellite observations, in-situ measurements, and model outputs. The library features a powerful dataset catalog system, enabling users to efficiently retrieve and work with data commonly used for ice sheet modelling, climate analysis, and cryospheric studies. @@ -24,7 +24,7 @@ As an open-source projects, both `CCD` and **ccdtools** encourage contributions Please see the `ACCESS-Hive Docs CCD page `_ for a full list and description of all available datasets. .. warning:: - ccdtools is under active development and remains a work in progress. Please let us know if anything is missing or if you have any suggestions for improvements by creating an issue on our `GitHub repository `_. + `ccdtools` is under active development and remains a work in progress. Please let us know if anything is missing or if you have any suggestions for improvements by creating an `issue on our GitHub repository `_. Quick Links ----------- diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 14bf6b8..d6f92f4 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,9 +1,6 @@ Installation ============ -.. warning:: - This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development. - **ccdtools** can be installed using PyPI or conda, or by cloning the repository directly from GitHub. Below are instructions for each method. Installing via PyPI diff --git a/docs/source/overview.rst b/docs/source/overview.rst index ee08eaf..86d0fe0 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -1,17 +1,13 @@ Overview: Features and Capabilities ======== -.. warning:: - This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development. - - The Cryosphere Community Datapool (CCD) and it's Python interface **ccdtools** are a powerful dataset management and sharing system with the following core capabilities: Key Features ----------- 1. **Unified Dataset Catalog:** -`CCD` provides a centralized catalog of cryosphere-focused datasets maintained in a flexible YAML configuration. The catalog currently includes elevation and geometry datasets (e.g., BedMachine Antarctica, Bedmap), geospatial boundaries, basal forcing models, and ice velocity measurements from various sources including MEaSUREs, ITS_LIVE, and InSAR observations. Please see the `ACCESS-Hive Docs CCD page `_ for a full list and description of all available datasets. +`CCD` provides a centralised catalog of cryosphere-focused datasets maintained in a flexible YAML configuration. The catalog currently includes elevation and geometry datasets (e.g., BedMachine Antarctica, Bedmap), geospatial boundaries, basal forcing models, and ice velocity measurements from various sources including MEaSUREs, ITS_LIVE, and InSAR observations. Please see the `ACCESS-Hive Docs CCD page `_ for a full list and description of all available datasets. 2. **Dataset Discovery and Search:** Users can easily explore available datasets through an interactive catalog interface **ccdtools**. The search functionality allows users to find datasets by keywords across multiple metadata fields including dataset names, display names, and descriptive tags (e.g., "antarctica", "ice velocity", "ice thickness"). diff --git a/src/ccdtools/catalog.py b/src/ccdtools/catalog.py index 2d31906..fcf0852 100644 --- a/src/ccdtools/catalog.py +++ b/src/ccdtools/catalog.py @@ -70,7 +70,7 @@ def __init__(self, yaml_path = None): # If yaml_path is not specified, use to default ../config/datasets.yaml if yaml_path is None: with resources.as_file( - resources.files(__package__).joinpath("config/datasets.yaml") + resources.files("ccdtools").joinpath("config/datasets.yaml") ) as p: self.config_file = Path(p) else: