ACCESS-NRI / ACCESS-Vis

Visualisation examples and resources, including open-source 3D vis for ACCESS-NRI releases
Apache License 2.0
1 stars 0 forks source link

Split the repository between an "ACCESS-Vis" package and a "ACCESS Visualisation recipes" repository #3

Closed rbeucher closed 1 month ago

rbeucher commented 1 month ago

Split the Repository into "ACCESS-Vis" Package and "ACCESS Visualisation Recipes" Repository

Description:

We need to split this repository into two separate repositories:

  1. ACCESS-Vis Package

    • This should contain the core visualisation library, including reusable code, utilities, and functions that are common across various visualisation tasks.
  2. ACCESS Visualisation Recipes

    • This repository will house specific visualisation recipes or scripts that rely on the ACCESS-Vis package but are tailored to particular datasets or use cases.

Action Required:

  1. Create a New Repository for "ACCESS Visualisation Recipes"

    • Set up a new GitHub repository specifically for the recipes.
    • Transfer the relevant recipe scripts from this repository into the new one, ensuring they properly reference the "ACCESS-Vis" package.
  2. Refactor the Current Repository into "ACCESS-Vis"

    • Retain the core visualisation functions and libraries here.
    • Ensure the code is packaged and modular, so it can be easily imported into the "ACCESS Visualisation Recipes" repository and other projects.
  3. Update Documentation

    • Update the README.md and any related documentation in both repositories to clearly explain their respective roles:
      • The "ACCESS-Vis" package for the core tools.
      • The "ACCESS Visualisation Recipes" repository for examples and specific use-case visualisations.
  4. Cross-Reference

    • Include instructions on how to install and use the "ACCESS-Vis" package within the "ACCESS Visualisation Recipes" repository.
rbeucher commented 1 month ago

I have started the process. See ACCESS-Visualisation-Recipes