Merge pull request #173 from CosmoStat/develop

Release 3.0.0 - Modelling Performance Enhancement(s)

Author: ChaitanyaChawak

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] Issue title"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the Bug**
+Please provide a clear and concise description of the type of bug.
+
+**Steps to Reproduce**
+Outline the steps to reproduce the behavior:
+
+**Expected Behavior**
+Clearly describe what you expected to happen.
+
+**Screenshots**
+If applicable, attach screenshots to help illustrate the problem.
+
+**Your Setup**
+- OS: [e.g., iOS]
+- Browser: [e.g., Chrome, Safari]
+- Version: [e.g., 22]
+
+**Additional Context**
+Include any other context about the problem here.
+
+Thank you for your cooperation in providing this bug report. Your input is valuable in helping us improve our system.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[NEW FEATURE] Feature Title"
+labels: enhancement
+assignees: ''
+
+---
+
+**Problem Description**
+Provide a clear and concise description of the problem your feature request aims to address. For example, share any frustrations or challenges you've encountered.
+
+**Proposed Solution**
+Describe the solution you envision. Be clear and concise about what you would like to see implemented.
+
+**Alternatives Considered**
+Share any alternative solutions or features you've thought about. Provide a brief description of each alternative.
+
+**Additional Context**
+Include any extra context or relevant screenshots regarding your feature request.
+
+Your insights and suggestions are highly valuable as we consider enhancing our project. Thank you for taking the time to contribute! 🚀
+
+

.github/ISSUE_TEMPLATE/help-wanted.md

@@ -0,0 +1,28 @@
+---
+name: Help Request
+about: General help needed
+title: "[HELP] Brief Description of Help Needed"
+labels: help wanted
+assignees: ''
+
+---
+
+**Description of Help Needed**
+Please provide a brief description of the issue or question you need help with.
+
+**Steps Taken**
+Outline any steps you've already taken to address the problem.
+
+**Relevant Information**
+Include any additional information that might help us better understand and address your request.
+
+**Your Setup**
+- OS: [e.g., iOS]
+- Browser: [e.g., Chrome, Safari]
+- Version: [e.g., 22]
+
+**Screenshots or Code Snippets (if applicable)**
+Attach any relevant screenshots or code snippets to provide more context.
+
+Thank you for reaching out! We'll do our best to assist you promptly. 🤝
+

.github/ISSUE_TEMPLATE/installation-issue.md

@@ -0,0 +1,31 @@
+---
+name: Installation Issue
+about: Problem with package installation
+title: "[INSTALL ISSUE] Brief Description of Installation Problem"
+labels: install issue
+assignees: ''
+
+---
+
+**Description of the Problem**
+Provide a clear and concise description of the problem encountered during installation.
+
+**Steps to Reproduce**
+Outline the steps to reproduce the behavior.
+
+**Screenshots (if applicable)**
+Attach any screenshots to help explain your problem.
+
+**Your Setup**
+- OS: [e.g., iOS]
+- Browser: [e.g., Chrome, Safari]
+- Version: [e.g., 22]
+
+**Error Messages (if any)**
+Include any error messages you received during the installation process.
+
+**Additional Context**
+Add any other relevant context about the problem here.
+
+Thank you for reporting the installation issue. We'll do our best to assist you in resolving it! 🛠️
+

.github/ISSUE_TEMPLATE/project-management.md

@@ -0,0 +1,39 @@
+---
+name: Project Management
+about: Issues related to the overall management of the project
+title: "[PROJECT] Brief Description of the Issue"
+labels: project management
+assignees: ''
+
+---
+
+**Description of the Issue**
+Provide a clear and concise description of the project management issue.
+
+**Goals and Objectives**
+Outline the primary goals and objectives associated with this issue or project.
+
+**Current Progress**
+Describe the current progress of the project or any specific milestones achieved.
+
+**Challenges and Risks**
+Identify any challenges or risks that may impact the project timeline or success.
+
+**Dependencies**
+List any dependencies or external factors that the team needs to consider for successful project management.
+
+**Team Collaboration**
+Describe how the team is collaborating on this project, including communication channels and collaboration tools used.
+
+**Next Steps**
+Outline the next steps or actions that need to be taken to address the project management issue.
+
+**Timeline and Milestones**
+Provide information on the project timeline and key milestones.
+
+**Additional Context**
+Include any other relevant context or information related to the project management problem.
+
+**Impact Assessment**
+Briefly assess the impact of this issue on the overall project.
+

.github/ISSUE_TEMPLATE/refactoring-request.md

@@ -0,0 +1,42 @@
+---
+name: Code Refactoring
+about: Request for refactoring or improving the codebase
+title: "[REFACTOR] Brief Description of Refactoring/Improvement"
+labels: refactor, enhancement
+assignees: ''
+
+---
+
+**Description of Refactoring/Improvement**
+Provide a clear and concise description of the codebase elements you'd like to refactor or improve.
+
+**Goals and Objectives**
+Outline the goals and objectives of the refactoring or improvement effort.
+
+**Current Code Behavior**
+Describe the current behavior of the code and any issues or challenges it presents.
+
+**Proposed Changes**
+Specify the changes you propose for the refactoring or improvement. Include code snippets if applicable.
+
+**Expected Benefits**
+Explain the expected benefits of the proposed changes, such as improved performance, readability, or maintainability.
+
+**Dependencies**
+List any dependencies or considerations related to other parts of the codebase.
+
+**Testing Plan**
+Provide a plan for testing the refactored or improved code.
+
+**Additional Context**
+Include any other relevant context or information related to the refactoring or improvement.
+
+**Impact Assessment**
+Briefly assess the impact of these changes on the overall codebase and project.
+
+**Next Steps**
+Outline the next steps or actions that need to be taken for the refactoring or improvement.
+
+
+Thank you for starting this request to refactor or improve the code. We will review it and collaborate to enhance the codebase together! 🛠️
+

.github/pull_request_template.md

@@ -0,0 +1,67 @@
+## Summary
+
+> Provide a concise description of the proposed changes.  
+> Include "closes #<ISSUE_NUMBER>" if this addresses an open issue <br>
+> **Note:** Validation tests and plots should **not** be added to the PR; they should be documented in the dedicated issue instead.
+
+
+## What’s changed
+
+> Describe the main changes introduced by this PR.  
+> Focus on user-visible changes, bug fixes, performance improvements, or internal changes.
+
+- Example bullet 1
+- Example bullet 2
+
+
+## How to test / verify
+
+> Outline steps for reviewers or maintainers to validate the changes.  
+> Include commands, scripts, or datasets if relevant.  
+> Full validation results should be referenced in the associated issue, not pasted here.
+
+- Step 1
+- Step 2
+
+
+## Scope
+
+> Indicate the type of PR:
+
+- [ ] Feature  
+- [ ] Bug fix  
+- [ ] Hotfix  
+- [ ] Documentation / process change  
+- [ ] Internal / refactor  
+
+> Optionally, note if this PR is part of a larger milestone or set of related PRs.
+
+
+## Changelog
+
+> Did this PR introduce user-visible changes?  
+> If yes, a **Scriv changelog fragment** must be added and committed.
+
+- [ ] Changelog fragment added (if applicable)
+
+
+## Reviewer Checklist
+
+> Reviewers should confirm the following before approving and merging:
+
+- [ ] The PR targets the `develop` branch
+- [ ] The PR is assigned to the developer
+- [ ] Appropriate labels are applied
+- [ ] The PR is included in relevant projects and/or milestones
+- [ ] Description clearly explains what has changed
+- [ ] Issue references included, if applicable
+- [ ] Code and documentation adhere to current standards (`ruff`)
+- [ ] Documentation updates included, if relevant
+- [ ] CI tests are passing
+- [ ] All reviewer comments have been addressed
+
+
+## Next Steps / Notes (if applicable)
+
+> Any follow-up actions, known issues, or reminders for maintainers.
+

.github/workflows/cd.yml

@@ -18,10 +18,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Set up Python 3.10.5
+      - name: Set up Python 3.10.11
         uses: actions/setup-python@v3
         with:
-          python-version: "3.10.5"
+          python-version: "3.10.11"
 
       - name: Check Python Version
         run: python --version
@@ -32,11 +32,11 @@ jobs:
      
       - name: Build API documentation
         run: |
-          sphinx-apidoc -Mfeo docs/source src/wf_psf
-          sphinx-build docs/source docs/build
+          make -C docs clean
+          make -C docs html
        
       - name: Deploy API documentation
         uses: peaceiris/actions-gh-pages@v3.5.9
         with:
            github_token: ${{ secrets.GITHUB_TOKEN }}
-           publish_dir: docs/build
+           publish_dir: docs/build/html

.github/workflows/cd_manual.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: CD_Manual
+
+on: [workflow_dispatch]
+
+jobs:
+  docs:
+    name: Test API documentation build
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      
+      - name: Set up Python 3.10.11
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10.11"
+          
+      - name: Check Python Version
+        run: python --version
+
+      - name: Install dependencies
+        run: |
+          python -m pip install ".[docs]"
+     
+      - name: Build API documentation
+        run: |
+          make -C docs clean
+          make -C docs html
+       
+      - name: Archive documentation as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: api-docs
+          publish_dir: docs/build/html

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# This workflow will install Python dependencies, run tests, and lint with multiple versions of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
 name: CI
@@ -11,19 +11,24 @@ on:
 
 jobs:
   test-full:
-    runs-on: [ubuntu-latest]
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
 
     steps:
-      - name:
+      - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Set up Python 3.10.5
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v3
         with:
-          python-version: "3.10.5"
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: python -m pip install ".[test]"
-       
+      
       - name: Test with pytest
         run: python -m pytest
+