uncscode / particula

a simple, fast, and powerful particle simulator
https://uncscode.github.io/particula
MIT License
6 stars 9 forks source link

Excise beta packages #507

Closed Gorkowski closed 1 month ago

Gorkowski commented 1 month ago

Fixes #503

removes beta packages and docs related to them

They are being moved to particula-beta repo.

Summary by Sourcery

Remove beta packages and associated documentation, cleaning up the codebase by deleting related files and sections in the documentation.

Documentation:

Chores:

github-actions[bot] commented 1 month ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://uncscode.github.io/particula/pr-preview/pr-507/ on branch gh-pages at 2024-10-16 12:39 UTC

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request removes beta packages and related documentation from the project. It involves deleting multiple files, removing references to beta features from documentation, and updating some existing documentation files.

Class diagram for removed beta packages

classDiagram
    class Loader {
        - loader.py
    }
    class Mixin {
        - mixin.py
    }
    class LoaderInterface {
        - loader_interface.py
    }
    class Stream {
        - stream.py
    }
    class Lake {
        - lake.py
    }
    class LakeStats {
        - lake_stats.py
    }
    class Merger {
        - merger.py
    }
    class SettingsGenerator {
        - settings_generator.py
    }
    class StreamStats {
        - stream_stats.py
    }
    class ParticlePairs {
        - particle_pairs.py
    }
    class ParticleProperty {
        - particle_property.py
    }
    class Collisions {
        - collisions.py
    }
    class Boundary {
        - boundary.py
    }
    class Integration {
        - integration.py
    }
    class OpticalInstrument {
        - optical_instrument.py
    }
    class MieBulk {
        - mie_bulk.py
    }
    class KappaViaExtinction {
        - kappa_via_extinction.py
    }
    class AerodynamicConvert {
        - aerodynamic_convert.py
    }
    class MieAngular {
        - mie_angular.py
    }
    class GenerateAndTrain2ModeSizer {
        - generate_and_train_2mode_sizer.py
    }
    class ChamberRateFitting {
        - chamber_rate_fitting.py
    }
    class SizeDistribution {
        - size_distribution.py
    }
    class ScatteringTruncation {
        - scattering_truncation.py
    }
    class GetMlFolder {
        - get_ml_folder.py
    }
    class GetExampleData {
        - get_example_data.py
    }
    class ExampleData {
        - example_data/
    }
    class Tests {
        - tests/
    }

File-Level Changes

Change Details Files
Removal of beta packages and related documentation
  • Deleted multiple files related to beta features
  • Removed references to beta features from documentation
  • Deleted notebooks associated with beta features
  • Removed beta-related Python modules and tests
docs/How-To-Guides/index.md
docs/Tutorials/index.md
docs/How-To-Guides/Chamber_Wall_Loss/index.md
particula/data/loader.py
particula/data/mixin.py
particula/lagrangian/particle_pairs.py
particula/data/process/ml_analysis/generate_and_train_2mode_sizer.py
docs/How-To-Guides/Light_Scattering/index.md
docs/How-To-Guides/Data_Streams_and_Lakes/index.md
docs/How-To-Guides/Lagrangian/index.md
docs/Tutorials/Data_Analysis/index.md
Updating documentation to remove beta feature references
  • Removed 'Light Scattering' section from How-To-Guides
  • Removed 'Data Streams and Lakes' section from How-To-Guides
  • Removed 'Lagrangian' section from How-To-Guides
  • Removed 'Data Analysis' section from Tutorials
docs/How-To-Guides/index.md
docs/Tutorials/index.md
Removal of specific beta feature notebooks and related files
  • Deleted notebooks related to data loading and analysis
  • Deleted notebooks for light scattering simulations
  • Deleted notebooks for Lagrangian simulations
  • Removed Chamber Wall Loss related notebooks
docs/How-To-Guides/Data_Streams_and_Lakes/notebooks/loading_data_part1.ipynb
docs/How-To-Guides/Data_Streams_and_Lakes/notebooks/loading_data_part2.ipynb
docs/How-To-Guides/Light_Scattering/notebooks/kappa_vs_extinction.ipynb
docs/How-To-Guides/Lagrangian/notebooks/turbulence_drops.ipynb
docs/How-To-Guides/Chamber_Wall_Loss/Notebooks/Chamber_Rates_Fitting.ipynb
docs/How-To-Guides/Chamber_Wall_Loss/Notebooks/Chamber_Observations.ipynb

Assessment against linked issues

Issue Objective Addressed Explanation
#503 Remove .data and .lagrangian code
#503 Remove documentation related to .data and .lagrangian
#503 Add website link to particula-beta package The PR diff does not show any additions of website links to the particula-beta package.

Possibly linked issues


Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).