Conversation
- Updated copyright year from 2022 to 2026 in LICENSE, main.py, and report.py files.
- Created a Makefile for Sphinx documentation build processes. - Added various tutorial notebooks and verification documents to support users in installation, simulation, and model verification. - Established a new reference section with detailed model specifications and configuration options.
- Introduced a new job in the GitHub Actions workflow to build documentation from the 'docs_new' directory, including executed notebooks.
- Added a mechanism to touch the file and update its modification time when the generated code is up-to-date, ensuring that any stale .pyc bytecode cache is invalidated on the next import.
…rogression behavior.
- Updated .gitignore to include generated model and config reference docs. - Modified Sphinx configuration to use absolute paths for model reference generation. - Improved notebook execution settings to allow automatic execution and error handling. - Added new reference documentation for API, CLI, and configuration options. - Updated various tutorial notebooks to include inline plotting and improved content. - Added verification documentation for model accuracy against established benchmarks.
…nd logic - Renamed parameter from 'fullname' to 'name' for clarity. - Enhanced docstring to provide detailed information on parameters, return values, and behavior regarding file extensions. - Updated logic to correctly handle numeric suffixes and preserve file extensions when adding a suffix.
…on is applied when saving figures. The logic now checks if the provided filename already includes the correct extension before appending it.
- Consolidate content into index.md and removing methodology.md.
…matting.
- Changed LaTeX variable names in ESAC5AData from 'T_F_X' to 'T_{F_X}' for consistency.
- Fixed documentation formatting in PIDController class to ensure proper line continuation in mathematical expressions.
…ents - Introduced get_tqdm function in shared.py to determine the appropriate tqdm progress bar based on the execution environment (terminal, Jupyter notebook, or batch). - Updated TDS class in tds.py to utilize get_tqdm for progress bar initialization, improving clarity and maintainability. - Added utility functions in misc.py to check for TTY and notebook frontend, enhancing environment detection capabilities.
- Renamed internal variables for summation and normalization factors from '_sumK18' and '_Kcoeff' to 'sumK18' and 'Kcoeff' respectively, enhancing readability. - Updated the corresponding calculations for normalized coefficients K1n to K8n to reflect the new variable names.
…to the index page.
- Updated Makefile to include a catch-all target for unknown Sphinx commands. - Configured LaTeX output options in conf.py to support Unicode with xelatex and defined document structure. - Added installation instructions using the 'uv' package installer in index.md and 01-installation.md, providing users with alternative installation methods and tips for using 'uv' effectively.
- Added LaTeX commands to control the depth of the table of contents for improved document structure. - Ensured proper formatting for both version 1.10 notes and the final version announcement.
- Introduced a new landing page detailing the features and installation instructions for the ANDES library. - Created an 'About' page outlining the library's key features, design philosophy, citation information, acknowledgments, and links to resources. - Updated the index page to include links to the new documentation sections, enhancing user navigation and accessibility.
…ssing
- Added 'sphinx_selective_exclude.eager_only' extension to enable selective processing of {only} directives during parsing.
- Updated LaTeX preamble in conf.py to adjust the header height and top margin, addressing a warning from the fancyhdr package while maintaining the table of contents structure.
- Included 'sphinx-design' and 'sphinx-selective-exclude' in both development and documentation dependencies to improve styling and selective content processing capabilities.
- Updated Makefile to include LaTeX build targets for PDF generation with reduced logging verbosity. `SPHINX_BUILD_PDF` ENV VAR is checked. - Added code snippets in multiple tutorials to suppress logging during PDF builds, improving output clarity. - Standardized numeric formatting in tutorial outputs for consistency across various notebooks. - Improved placeholder and value formatting in interactive elements to enhance user experience.
…ooks to improve clarity in PDF builds. Added a note in the first simulation tutorial regarding hidden outputs in the PDF version, directing users to the online documentation for full details.
- Introduced a new HTML landing page (_html_landing.rst) to provide an overview of the ANDES library, including key features and installation instructions. - Removed the old markdown landing page (_landing.md) and updated the index page to link to the new HTML structure. - Enhanced the 'About' page to include detailed descriptions of the symbolic-numeric framework and model library. - Updated the modeling and tutorial sections to improve navigation and accessibility for users.
- Added a new "Verification" section to the HTML landing page, highlighting validation against commercial tools and numerical accuracy. - Updated the example in the Quick Example section to use a fault case file for improved demonstration. - Refined learning paths for both Power System Analysts and Model Developers by removing redundant steps and improving clarity. - Introduced a new SVG logo for ANDES in the documentation. - Updated Sphinx configuration to include the new logo and improve overall documentation presentation.
- Introduced a new "Sponsors" section in the HTML landing page, highlighting the support from various organizations. - Added new sponsor logos for the National Academies, NC State University, and NLR. - Updated the layout to enhance visual presentation of sponsor information.
…guration - Introduced a new "Useful Links" section in the HTML landing page, providing quick access to report issues, Q&A discussions, try online features, and the repository. - Added a link to the PDF manual in the Sphinx configuration for easier access to documentation 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.
This is a major overhaul of the documentation, aiming to combine example notebooks into the tutorial/guide and streamline documentation testing.
docs.