Documentation - #14
Merged
Merged
Conversation
- Added a new section for the legacy workflow in the documentation, detailing the original API and its usage. - Created a dedicated organization plan for documentation to clarify structure and user journeys. - Improved the introduction and overview sections to guide users towards the modern workflow. - Updated various documentation files to reflect changes in the API and user guidance.
- Completed documentation for `compact_output` in the PVLib model, clarifying its default behavior and usage. - Enhanced the wind modeling documentation to include detailed estimate options for spatial and temporal subsetting, addressing slice order behavior on descending latitude grids. - Updated various sections across modeling documentation to ensure consistency and clarity regarding estimation methods and parameters.
- Added `xarray_mask_tutorial.ipynb` to the documentation under the `mask/` directory, ensuring it is included in the toctree. - Updated `xarray_mask_workflow.rst` to reference the new tutorial, providing users with a step-by-step guide for the xarray masking workflow. - Clarified documentation structure to enhance navigation and accessibility of resources.
- Updated the wind modeling documentation to clarify the estimation of wind turbine capacity factors (CF) using both interpolation and extrapolation models. - Improved explanations for the `estimate` method and the output structure, ensuring users understand how to utilize the available wind turbine models effectively. - Revised the toctree entries and documentation structure to enhance navigation and consistency across modeling resources.
- Removed MERRA2-specific tutorials from the main documentation and relocated them to a legacy section, clarifying that MERRA2 is only supported through the legacy API. - Updated references in the documentation to guide users towards the new structure and legacy resources. - Enhanced the organization of the documentation to improve navigation and accessibility for users transitioning from the legacy API.
- Modified the Read the Docs configuration to avoid memory issues by installing only necessary dependencies for documentation. - Updated the Sphinx configuration to read the project version from a file without importing the main package, ensuring compatibility with RTD's no-deps installation. - Improved the overall structure of the documentation build process for better efficiency.
- Updated the `index.rst` to include specific mask tutorials and troubleshooting documentation, enhancing the structure of the mask section. - Renamed references in the `intro.rst` to point to the new `xarray_mask_tutorial` for clarity. - Removed the obsolete `mask_xarray_migration_plan.md` and updated the documentation to reflect the new organization of mask-related resources. - Enhanced the `xarray_mask_tutorial.ipynb` to provide clearer guidance on using the xarray-based masking workflow, including updated links to relevant documentation. - Deleted the `xarray_mask_workflow.rst` as part of the documentation restructuring.
- Revised the ERA5 documentation to emphasize the recommended method for downloading data via Geodata, reducing the need for direct `cdsapi` calls. - Clarified the steps for setting up a CDS account and configuring API credentials, ensuring users understand the process. - Enhanced examples for downloading ERA5 data, including specific use cases for 3D wind and 2D wind/solar datasets. - Added links to relevant sections for offline development and CI without CDS, improving accessibility to fixture datasets. - Updated the overview section to provide a clearer structure and guidance for users navigating ERA5 data management.
…orial - Enhanced the wind modeling documentation to clarify the usage of the `geodata.model.wind` module and its capabilities for estimating wind speed. - Updated references in the `intro.rst` to reflect changes in wind modeling terminology and improved clarity on interpolation and turbine capacity factor estimation. - Removed the outdated `extrapolation.rst` tutorial, consolidating information to streamline the documentation structure. - Added new sections in the `index.rst` and `quick_start` to improve navigation and accessibility of wind-related resources.
- Added a reference to the new `modeling/era5_outputs` section in the `index.rst` for improved navigation. - Deleted the outdated `era5_outputs.md` file, consolidating information to streamline the documentation. - Updated links in the `quick_start/input_output.md` to point to the new modeling outputs, ensuring users have access to the latest resources.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating the documentation