Merge pull request #12 from ahnaf-tahmid-chowdhury/release-0.1.2

release v0.1.2
nukehub-dev · Sep 6, 2023 · 359c7e0 · 359c7e0
2 parents 1acbcc9 + 7da576a
commit 359c7e0
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 60 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md
@@ -1,30 +1,34 @@
 ---
 name: Bug Report
 about: Report a bug or issue to enhance the quality of NuclearKid
-title: '[BUG] Concise description of the bug'
+title: "[BUG] Concise description of the bug"
 labels: bug
-assignees: ''
+assignees: ""
 ---
 
-**Bug Description**
-
+**Description**
+<!--
 Explain the bug clearly and concisely, detailing the issue you encountered.
+-->
 
-**Steps to Reproduce**
 
+**Steps to Reproduce**
+<!--
 Provide a step-by-step guide on how to reproduce the bug:
+-->
 
-1. Step 1
-2. Step 2
-3. ...
 
 **Expected Outcome**
-
+<!--
 A brief description of what you expected to happen instead.
+-->
 
-**Screenshots/Logs**
 
+**Screenshots/Logs**
+<!--
 If applicable, attach relevant screenshots, error logs, or code snippets to provide visual context.
+-->
+
 
 **Environment Information:**
 
@@ -35,5 +39,8 @@ If applicable, attach relevant screenshots, error logs, or code snippets to prov
 - Additional relevant details
 
 **Additional Context**
-
+<!--
 Any other contextual information that could assist in understanding the bug.
+-->
+
+
diff --git a/.github/ISSUE_TEMPLATE/feature-request-template.md b/.github/ISSUE_TEMPLATE/feature-request-template.md
@@ -1,27 +1,37 @@
 ---
 name: Feature Request
 about: Suggest enhancements or new features to elevate NuclearKid
-title: '[FEATURE] Concise description of the feature'
+title: "[FEATURE] Concise description of the feature"
 labels: enhancement
-assignees: ''
+assignees: ""
 ---
 
-**Feature Description**
-
+**Description**
+<!--
 Provide a clear and detailed description of the enhancement or feature you're proposing.
+-->
 
-**Use Case**
 
+**Use Case**
+<!--
 Explain the context in which this feature would be valuable, along with its potential benefits.
+-->
 
-**Proposed Solution**
 
+**Proposed Solution**
+<!--
 If you have a specific solution in mind, describe it comprehensively. If not, outline the problem in detail.
+-->
 
-**Alternatives Considered**
 
+**Alternatives Considered**
+<!--
 Share any alternative solutions or approaches you've considered, and why you believe your proposal is superior.
+-->
 
-**Additional Context**
 
+**Additional Context**
+<!--
 Include any other pertinent information, such as relevant industry trends or user preferences.
+-->
+
diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md
@@ -1,34 +1,39 @@
 ---
 name: Pull Request
 about: Submit changes to NuclearKid for review and inclusion
-title: '[PR] Concise description of your changes'
+title: "[PR] Concise description of your changes"
 labels: enhancement
-assignees: ''
+assignees: ""
 ---
 
-**Pull Request Description**
-
+**Description**
+<!--
 Explain the purpose and context of your pull request. What changes have you made and why?
+-->
 
-**Related Issue(s)**
 
+**Related Issue(s)**
+<!--
 If this pull request is related to an open issue, provide the issue number and a brief description.
+-->
 
 **Changes Made**
-
+<!--
 A clear and concise description of the changes you've made in this pull request.
+-->
 
-**Steps to Test**
 
+**Steps to Test**
+<!--
 Provide step-by-step instructions on how the reviewer can test your changes:
+-->
 
-1. Step 1
-2. Step 2
-3. ...
 
 **Screenshots/Logs**
-
+<!--
 If applicable, include screenshots, output logs, or other visuals that help illustrate the changes.
+-->
+
 
 **Checklist**
 
@@ -45,16 +50,22 @@ If applicable, include screenshots, output logs, or other visuals that help illu
 - Relevant Package Versions: [e.g. PyNE 0.7.0, OpenMC 0.13.1-dev]
 
 **Additional Context**
-
+<!--
 Any extra context or information that the reviewer should know about the changes.
+-->
 
-**Screenshots**
 
+**Screenshots**
+<!--
 If applicable, provide screenshots or visuals demonstrating the changes.
+-->
 
-**Reviewer Notes**
 
+**Reviewer Notes**
+<!--
 Notes to the reviewer, if needed.
+-->
+
 
 **Please confirm that you have followed our contributing guidelines and code of conduct.**
 

diff --git a/.github/workflows/run_build_and_test.yml b/.github/workflows/run_build_and_test.yml
@@ -37,7 +37,6 @@ jobs:
 
       - name: Install NuclearKid
         run: |
-          chmod +x install-nuclearkid.sh
           ./install-nuclearkid.sh -d ${GITHUB_WORKSPACE} \
             -e nuclearkid \
             -g ${GITHUB_WORKSPACE}/nuclearkid/G4Data \

diff --git a/README.md b/README.md
@@ -18,12 +18,12 @@ This package manager is designed to set up a development environment for nuclear
 
    **Using wget:**
    ```sh
-   wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz
+   wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" -O - | tar -xz
 
    ```
    **Using curl:**
    ```sh
-   curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" | tar -xz
+   curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" | tar -xz
    ```
    **Using Git:** (Download the most recent commit) 
    ```sh

diff --git a/docs/conf.py b/docs/conf.py
@@ -7,6 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 import re
+import datetime
 
 # Define a regular expression pattern to match the Version variable in install.sh
 version_pattern = r'Version\s*=\s*"([^"]+)"'
@@ -22,12 +23,11 @@
     # Extract the version from the matched group
     version = match.group(1)
 else:
-    # Set a default version if not found
-    version = "Unknown"
+    # If the version is not found, raise an error
+    raise RuntimeError("Version not found in install-nuclearkid.sh file")
 
 project = "NuclearKid"
-copyright = "2023, Ahnaf Tahmid Chowdhury"
-author = "Ahnaf Tahmid Chowdhury"
+copyright = "{0}, NuclearKid Team".format(datetime.datetime.now().year)
 release = version
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/contents/installation-guide.md b/docs/contents/installation-guide.md
@@ -6,22 +6,31 @@ Follow these steps to install **NuclearKid** on your local machine.
 
 You can download the latest release of **NuclearKid** from the [GitHub releases page](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/latest). You have multiple options for downloading:
 
-### Using wget:
+```{eval-rst}
+.. tabs::
 
-```sh
-wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz
-```
+   .. tab:: Wget
 
-### Using curl:
+      .. code-block:: sh
 
-```sh
-curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" | tar -xz
-```
+         wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" -O - | tar -xz
 
-### Using Git (Download the most recent commit):
 
-```sh
-git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git"
+   .. tab:: Curl
+
+      .. code-block:: sh
+
+         curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" | tar -xz
+
+   .. tab:: Git
+
+      .. note::
+         This will download the most recent commit
+
+      .. code-block:: sh
+
+         git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git"
+
 ```
 
 ## Step 2: Navigate to the NuclearKid Directory
@@ -80,4 +89,4 @@ nuclearkid activate
 pip3 install -r packages.txt --default-timeout=0
 ```
 
-Please ensure that you have appropriate permissions to install software on your system. The script may require you to enter your administrator password (sudo) during the installation process.
+Please ensure that you have appropriate permissions to install software on your system. The script may require you to enter your administrator password `sudo` during the installation process.
diff --git a/docs/contents/releasenotes/index.md b/docs/contents/releasenotes/index.md
@@ -1,10 +1,13 @@
 # Release Notes
 
+This section provides a summary of version updates and changes for NuclearKid.
+
 ```{toctree}
 :maxdepth: 1
 :caption: Versions
 :titlesonly: true
 
+v0.1.2
 v0.1.1
 v0.1.0
 v0.0.1

diff --git a/docs/contents/releasenotes/v0.1.2.md b/docs/contents/releasenotes/v0.1.2.md
@@ -0,0 +1,15 @@
+# [v0.1.2] - 06/09/2023
+
+## Added
+- Sphinx documentation. (#6 #7)
+- ReadTheDocs webpage. (#6 #7)
+
+## Changed
+- Remove ethicalads. (#8 #9)
+- Rename `nuclearboy` to `nuclearkid`. (#10)
+- Rename NuclearBoy to NuclearKid. (#10 #11)
+
+
+**Full Changelog**: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/compare/v0.1.1...v0.1.2
+
+[v0.1.2]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.1.2
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,7 @@
 # Welcome to NuclearKid
 
 ## 📦 What is NuclearKid?
+
 **NuclearKid** is an efficient package manager specifically crafted to simplify the installation and management of vital packages and libraries required for nuclear physics simulations and analyses. It automates the setup procedure for essential tools like [PyNE][pyne], [OpenMC][openmc], [DAGMC][dagmc], and [Geant4][geant4], making the life of nuclear physics enthusiasts much more convenient.
 
 [pyne]: https://pyne.io/
@@ -9,35 +10,39 @@
 [geant4]: https://geant4.web.cern.ch/
 
 ## 🚀 How to Get Started?
+
 - Download the latest release.
-- Extract it onto your local machine.
-- Navigate to the NuclearKid directory.
 - Execute the `install-nuclearkid.sh` script.
 - Follow the prompts to customize your installation.
 
 ## 🛠 Installation Options
+
 **NuclearKid** provides installation flexibility, allowing you to choose your installation directory, environment name, Geant4 data library path, and cross-section library path. You can even opt to automatically download Geant4 data and cross-sections.
 
 ## ⚙ How It Works
+
 **NuclearKid** takes care of all the heavy lifting for you. It identifies your operating system, installs necessary dependencies, and configures Python environments. It also offers convenient commands for activation, deactivation, updating, and more!
 
 ## 🚨 Important Notes
+
 Before running the script on your system, please carefully review it and understand the installation process. Safety first!
 
-Currently, **NuclearKid** supports Debian-based distributions. It compiles packages from source, which can be time-consuming. Our team is actively working on creating binary packages for internal components.
+Currently, **NuclearKid** supports [Debian-based distributions](https://en.wikipedia.org/wiki/Category:Debian-based_distributions). Additionally, It compiles packages from source, which can be time-consuming. Our team is actively working on creating binary packages for internal components.
 
 ## 📜 License
+
 **NuclearKid** is distributed under the [MIT License](contents/license).
 
 ## 🤝 Contributing
-Contributions to this project are highly encouraged! If you encounter issues or have suggestions for improvements, please don't hesitate to get in touch. Check our [Contributing Guidelines](contents/contributing) for more information.
 
+Contributions to this project are highly encouraged! If you encounter issues or have suggestions for improvements, please don't hesitate to get in touch. Check our [Contributing Guidelines](contents/contributing) for more information.
 
 ```{toctree}
 :maxdepth: 1
 :caption: Contents
 :hidden: true
 
+index
 contents/installation-guide
 contents/releasenotes/index
 contents/methodology
@@ -48,7 +53,3 @@ contents/code-of-conduct
 contents/license
 contents/contact
 ```
-
-
-
-
diff --git a/install-nuclearkid.sh b/install-nuclearkid.sh