From c55b99f5d07f8f6ac343ba87dfe9123698323567 Mon Sep 17 00:00:00 2001 From: Ahnaf Tahmid Chowdhury Date: Wed, 6 Sep 2023 10:54:50 +0600 Subject: [PATCH 1/4] NuclearBoy -> NuclearKid --- .github/ISSUE_TEMPLATE/bug-report-template.md | 4 +- .../feature-request-template.md | 2 +- .../logo/{nuclear-boy.svg => nuclearkid.svg} | 2 +- .github/pull-request-template.md | 2 +- .github/workflows/run_build_and_test.yml | 16 ++--- CITATION.cff | 8 +-- CODE_OF_CONDUCT.md | 4 +- CONTRIBUTING.md | 26 +++---- LICENSE | 15 ++-- README.md | 64 ++++++++--------- SECURITY.md | 4 +- docs/conf.py | 22 +++--- docs/contents/importent-notes.md | 6 +- docs/contents/installation-guide.md | 28 ++++---- docs/contents/methodology.md | 2 +- docs/contents/usage.md | 68 +++++++++---------- docs/index.md | 18 ++--- install-nuclear-boy.sh | 66 +++++++++--------- 18 files changed, 176 insertions(+), 181 deletions(-) rename .github/logo/{nuclear-boy.svg => nuclearkid.svg} (99%) diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md index d395bf9..6ced36b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report-template.md +++ b/.github/ISSUE_TEMPLATE/bug-report-template.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Report a bug or issue to enhance the quality of NuclearBoy +about: Report a bug or issue to enhance the quality of NuclearKid title: '[BUG] Concise description of the bug' labels: bug assignees: '' @@ -29,7 +29,7 @@ If applicable, attach relevant screenshots, error logs, or code snippets to prov **Environment Information:** - Operating System: [e.g. Ubuntu 22.04] -- NuclearBoy Version: [e.g. 0.1.0] +- NuclearKid Version: [e.g. 0.1.0] - Python Version: [e.g. 3.11.4] - Relevant Package Versions: [e.g. PyNE 0.7.1] - Additional relevant details diff --git a/.github/ISSUE_TEMPLATE/feature-request-template.md b/.github/ISSUE_TEMPLATE/feature-request-template.md index ad9d2e4..9cb3c6c 100644 --- a/.github/ISSUE_TEMPLATE/feature-request-template.md +++ b/.github/ISSUE_TEMPLATE/feature-request-template.md @@ -1,6 +1,6 @@ --- name: Feature Request -about: Suggest enhancements or new features to elevate NuclearBoy +about: Suggest enhancements or new features to elevate NuclearKid title: '[FEATURE] Concise description of the feature' labels: enhancement assignees: '' diff --git a/.github/logo/nuclear-boy.svg b/.github/logo/nuclearkid.svg similarity index 99% rename from .github/logo/nuclear-boy.svg rename to .github/logo/nuclearkid.svg index dcc1a82..52b8e08 100644 --- a/.github/logo/nuclear-boy.svg +++ b/.github/logo/nuclearkid.svg @@ -3,7 +3,7 @@ version="1.1" viewBox="0 0 350 500" id="svg391" - sodipodi:docname="nuclear-boy.svg" + sodipodi:docname="nuclearkid.svg" inkscape:version="1.2.2 (b0a8486541, 2022-12-01)" width="350" height="500" diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 8e2bcb7..c3097af 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,6 +1,6 @@ --- name: Pull Request -about: Submit changes to NuclearBoy for review and inclusion +about: Submit changes to NuclearKid for review and inclusion title: '[PR] Concise description of your changes' labels: enhancement assignees: '' diff --git a/.github/workflows/run_build_and_test.yml b/.github/workflows/run_build_and_test.yml index d197fce..9d00ad3 100644 --- a/.github/workflows/run_build_and_test.yml +++ b/.github/workflows/run_build_and_test.yml @@ -9,7 +9,7 @@ on: - develop paths: - '.github/workflows/run_build_and_test.yml' - - 'install-nuclear-boy.sh' + - 'install-nuclearkid.sh' - 'tests/**' jobs: @@ -35,16 +35,16 @@ jobs: with: python-version: 3.11 - - name: Install NuclearBoy + - name: Install NuclearKid run: | - ./install-nuclear-boy.sh -d ${GITHUB_WORKSPACE} \ - -e nuclear-boy \ - -g ${GITHUB_WORKSPACE}/nuclear-boy/G4Data \ - -c ${GITHUB_WORKSPACE}/nuclear-boy/CrossSectionData + ./install-nuclearkid.sh -d ${GITHUB_WORKSPACE} \ + -e nuclearkid \ + -g ${GITHUB_WORKSPACE}/nuclearkid/G4Data \ + -c ${GITHUB_WORKSPACE}/nuclearkid/CrossSectionData - name: Run tests run: | - source ${GITHUB_WORKSPACE}/nuclear-boy/nuclear-boy - nuclear-boy activate + source ${GITHUB_WORKSPACE}/nuclearkid/nuclearkid + nuclearkid activate python -m pip install pytest python -m pytest -ra tests \ No newline at end of file diff --git a/CITATION.cff b/CITATION.cff index a99f78d..e4b6e96 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,6 +1,6 @@ cff-version: 1.2.0 title: >- - NuclearBoy: Package Manager for Nuclear Engineering + NuclearKid: Package Manager for Nuclear Engineering Development message: Nuclear Physics Simulation Toolkit type: software @@ -13,9 +13,9 @@ authors: identifiers: - type: doi value: 10.5281/zenodo.8307492 -repository-code: 'https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy' +repository-code: 'https://github.com/ahnaf-tahmid-chowdhury/NuclearKid' abstract: >- - NuclearBoy is a versatile package manager tailored for + NuclearKid is a versatile package manager tailored for nuclear engineering development, streamlining the setup of a comprehensive development environment for nuclear physics simulations and calculations. It facilitates the @@ -26,7 +26,7 @@ abstract: >- dependencies, creates a Python virtual environment, and installs the required components. With user-configurable options and a straightforward installation process, - NuclearBoy simplifies the often complex task of setting up + NuclearKid simplifies the often complex task of setting up a nuclear engineering development environment, making it an invaluable tool for researchers and engineers in the field. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 544fa06..55aac36 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,6 @@ # Code of Conduct -We, the contributors and maintainers of the NuclearBoy project, are committed to fostering an inclusive and welcoming community. This Code of Conduct outlines our expectations for all those who participate in our project, as well as the consequences for unacceptable behavior. +We, the contributors and maintainers of the NuclearKid project, are committed to fostering an inclusive and welcoming community. This Code of Conduct outlines our expectations for all those who participate in our project, as well as the consequences for unacceptable behavior. ## Our Pledge @@ -28,7 +28,7 @@ Unacceptable behaviors include, but are not limited to: ## Consequences of Unacceptable Behavior -Unacceptable behavior will not be tolerated within the NuclearBoy community. Anyone asked to stop unacceptable behavior is expected to comply immediately. +Unacceptable behavior will not be tolerated within the NuclearKid community. Anyone asked to stop unacceptable behavior is expected to comply immediately. If a participant engages in unacceptable behavior, the maintainers may take any action they deem appropriate, up to and including expulsion from the project's community and public communication channels, temporary or permanent bans, and reporting to appropriate authorities. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b85585..ae677a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to NuclearBoy +# Contributing to NuclearKid -Thank you for your interest in contributing to **NuclearBoy**! We appreciate your efforts to improve the project and make it more useful for the nuclear physics community. +Thank you for your interest in contributing to **NuclearKid**! We appreciate your efforts to improve the project and make it more useful for the nuclear physics community. ## Code of Conduct @@ -10,42 +10,42 @@ Please review and adhere to our [Code of Conduct][code-of-conduct] to ensure a r ### Reporting Bugs -If you encounter a bug while using **NuclearBoy**, we want to know! Please follow these steps: +If you encounter a bug while using **NuclearKid**, we want to know! Please follow these steps: -1. Check the [existing issues](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/issues) to see if the bug has already been reported. -2. If the bug is new, [open a new issue](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/issues/new) with a detailed bug report using the provided [bug report template][bug-report-template]. +1. Check the [existing issues](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/issues) to see if the bug has already been reported. +2. If the bug is new, [open a new issue](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/issues/new) with a detailed bug report using the provided [bug report template][bug-report-template]. 3. Provide a clear description of the bug, steps to reproduce it, and your environment details. ### Suggesting Enhancements Have an idea for a new feature or improvement? We'd love to hear it! Here's what you can do: -1. Review the [existing issues](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/issues) to avoid duplicate suggestions. -2. If your idea is new, [open a new issue](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/issues/new) with a detailed description using the provided [feature request template][feature-request-template]. +1. Review the [existing issues](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/issues) to avoid duplicate suggestions. +2. If your idea is new, [open a new issue](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/issues/new) with a detailed description using the provided [feature request template][feature-request-template]. 3. Explain why you think this enhancement is valuable and how it could benefit the users. ### Submitting Pull Requests -Contributions from the community help us grow and improve **NuclearBoy**. Follow these steps to submit a pull request: +Contributions from the community help us grow and improve **NuclearKid**. Follow these steps to submit a pull request: 1. Fork the repository and create a new branch for your changes. 2. Make your modifications, adhering to the coding guidelines. 3. Test your changes thoroughly to ensure they work as intended. -4. [Open a new pull request](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/compare) using the provided [pull request template][pull-request-template]. +4. [Open a new pull request](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/compare) using the provided [pull request template][pull-request-template]. 5. Provide a clear description of the changes, the problem they solve, and the testing steps. ## Development Setup If you're interested in contributing code, here's how to set up your development environment: -1. Fork the [repository](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/fork). +1. Fork the [repository](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/fork). 1. Clone your fork of the repository: ```sh git clone https://github.com//.git` ``` 2. Navigate to the project directory: `cd ` 3. Check out development branch: `git checkout develop` -4. Run the script: `./install-nuclear-boy.sh` and install NuclearBoy +4. Run the script: `./install-nuclearkid.sh` and install NuclearKid 5. Install dependencies: `pip install -r packages.txt` 6. Run tests: `pytest -ra tests` @@ -55,9 +55,9 @@ Please adhere to the established coding guidelines to maintain consistency acros ## License -By contributing to **NuclearBoy**, you agree that your contributions will be licensed under the project's [license][license]. Your contributions will be acknowledged in the project's list of contributors. +By contributing to **NuclearKid**, you agree that your contributions will be licensed under the project's [license][license]. Your contributions will be acknowledged in the project's list of contributors. -Thank you for contributing to **NuclearBoy**! +Thank you for contributing to **NuclearKid**! [bug-report-template]: .github/ISSUE_TEMPLATE/bug-report-template.md diff --git a/LICENSE b/LICENSE index 6c25b08..4ec4125 100644 --- a/LICENSE +++ b/LICENSE @@ -2,22 +2,17 @@ Copyright (c) 2023 Ahnaf Tahmid Chowdhury -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: ## Conditions: -- The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. ## Warranty: -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, diff --git a/README.md b/README.md index 992a42c..57ef0c6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# NuclearBoy +# NuclearKid -![Build and Test](https://img.shields.io/github/actions/workflow/status/ahnaf-tahmid-chowdhury/NuclearBoy/run_build_and_test.yml?style=flat-square&logo=githubactions&logoColor=white&label=Build%20and%20Test +![Build and Test](https://img.shields.io/github/actions/workflow/status/ahnaf-tahmid-chowdhury/NuclearKid/run_build_and_test.yml?style=flat-square&logo=githubactions&logoColor=white&label=Build%20and%20Test ) -![Release](https://img.shields.io/github/v/release/ahnaf-tahmid-chowdhury/NuclearBoy?style=flat-square&logo=github&label=Release&include_prereleases) +![Release](https://img.shields.io/github/v/release/ahnaf-tahmid-chowdhury/NuclearKid?style=flat-square&logo=github&label=Release&include_prereleases) [![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.8307492-blue?style=flat-square)](https://doi.org/10.5281/zenodo.8307492) This package manager is designed to set up a development environment for nuclear physics simulations and calculations. It automates the installation/update of various packages and libraries ([PyNE][pyne], [OpenMC][openmc], [DAGMC][dagmc], and [Geant4][geant4]) required for running nuclear physics simulations and analyses. @@ -14,38 +14,38 @@ This package manager is designed to set up a development environment for nuclear ## Usage -1. Download the [latest release](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/latest) and extract it to your local machine. +1. Download the [latest release](https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/latest) and extract it to your local machine. **Using wget:** ```sh - wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz + wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz ``` **Using curl:** ```sh - curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/archive/refs/tags/v0.1.1.tar.gz" | tar -xz + curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" | tar -xz ``` **Using Git:** (Download the most recent commit) ```sh - git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy.git" + git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git" ``` -2. Go to the NuclearBoy directory. +2. Go to the NuclearKid directory. ```sh - cd NuclearBoy* + cd NuclearKid* ``` -3. Make the `install-nuclear-boy.sh` script executable. +3. Make the `install-nuclearkid.sh` script executable. ```sh - chmod +x install-nuclear-boy.sh + chmod +x install-nuclearkid.sh ``` 4. Run the script. ```sh - ./install-nuclear-boy.sh + ./install-nuclearkid.sh ``` The script will guide you through the installation process and prompt you for necessary configuration options. @@ -56,7 +56,7 @@ During the installation process, you'll be asked for the following configuration 1. **Installation Directory Path**: Set the path where all the software will be installed. You can use the current directory or specify a custom directory. -2. **Environment Name**: Enter a name for the virtual environment that will be created. The default name is `nuclear-boy`, but you can provide a custom name. +2. **Environment Name**: Enter a name for the virtual environment that will be created. The default name is `nuclearkid`, but you can provide a custom name. 3. **Geant4 Data Library Path**: If you choose to install Geant4 data, provide the path for the Geant4 data library. The default is a directory within the virtual environment. @@ -71,7 +71,7 @@ During the installation process, you'll be asked for the following configuration You can also provide the configuration options directly from the command line. ```sh -./install-nuclear-boy.sh -d \ +./install-nuclearkid.sh -d \ -e \ -g \ -c @@ -133,50 +133,50 @@ You can also provide the configuration options directly from the command line. The script creates an executable program file (shell script) in the specified installation directory with the given environment name. 10. **Add to Path:** - The script adds the NuclearBoy directory to the user's `PATH` environment variable. + The script adds the NuclearKid directory to the user's `PATH` environment variable. ## Activation and Usage -Once the installation is complete, the script will create a program file named after the specified environment name (e.g., `nuclear-boy`). +Once the installation is complete, the script will create a program file named after the specified environment name (e.g., `nuclearkid`). **Commands:** - `-h` or `--help`: Display help - `-V` or `--version`: Display version -- `activate`: Activate the NuclearBoy environment -- `deactivate`: Deactivate the NuclearBoy environment +- `activate`: Activate the NuclearKid environment +- `deactivate`: Deactivate the NuclearKid environment - `update `: Update component - - `core`: Update NuclearBoy + - `core`: Update NuclearKid - `geant4`: Update Geant4 to the latest version - `dagmc`: Update DAGMC to the latest version - `openmc`: Update OpenMC to the latest version - `pyne`: Update PyNE to the latest version - - `all`: Update all components (NuclearBoy, Geant4, DAGMC, OpenMC, and PyNE) + - `all`: Update all components (NuclearKid, Geant4, DAGMC, OpenMC, and PyNE) - `endf `: Set the path for cross-section data library: - `endfb70`: ENDF/B-VII.0 (70) - `endfb71`: ENDF/B-VII.1 (71) - `lib80x`: ENDF/B-VIII.0/X (80X) -- `uninstall`: Uninstall the NuclearBoy toolkit +- `uninstall`: Uninstall the NuclearKid toolkit **Usage:** ```sh -nuclear-boy [options] +nuclearkid [options] ``` **Note:** -- Use `activate` to activate the NuclearBoy environment. -- Use `deactivate` to deactivate the NuclearBoy environment. +- Use `activate` to activate the NuclearKid environment. +- Use `deactivate` to deactivate the NuclearKid environment. - Use `update` with specific components to update them individually. - Use `update all` to update all components. - Use `endf ` to set the cross-section data library path. -- Use `uninstall` to completely uninstall the NuclearBoy toolkit. +- Use `uninstall` to completely uninstall the NuclearKid toolkit. **Examples:** ```sh -nuclear-boy activate -nuclear-boy update geant4 -nuclear-boy update all -nuclear-boy endf endfb70 -nuclear-boy uninstall +nuclearkid activate +nuclearkid update geant4 +nuclearkid update all +nuclearkid endf endfb70 +nuclearkid uninstall ``` ## Recommended Packages @@ -184,7 +184,7 @@ nuclear-boy uninstall The installer script provides a list of recommended Python packages in the `packages.txt` file. These packages complement the functionality of the installed software. To install them, use: ```sh -nuclear-boy activate +nuclearkid activate pip3 install -r packages.txt --default-timeout=0 ``` @@ -203,7 +203,7 @@ This project is licensed under the [MIT License](LICENSE). ## Disclaimer -The NuclearBoy program is provided for informational purposes only. The authors and contributors are not responsible for any damages or issues caused by using this script. Use it at your own risk. +The NuclearKid program is provided for informational purposes only. The authors and contributors are not responsible for any damages or issues caused by using this script. Use it at your own risk. ## Contributing diff --git a/SECURITY.md b/SECURITY.md index 35c9b4a..da8c4b0 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Reporting Security Vulnerabilities -At NuclearBoy, we take security vulnerabilities seriously and appreciate the efforts of security researchers and users in reporting potential issues. If you discover a security vulnerability in NuclearBoy, we kindly request that you follow responsible disclosure practices by adhering to the following guidelines: +At NuclearKid, we take security vulnerabilities seriously and appreciate the efforts of security researchers and users in reporting potential issues. If you discover a security vulnerability in NuclearKid, we kindly request that you follow responsible disclosure practices by adhering to the following guidelines: ### Reporting Process @@ -21,6 +21,6 @@ We are committed to addressing security vulnerabilities in a timely manner and e Upon receiving a security vulnerability report, our security team will promptly review and assess the issue. We will work diligently to develop and test appropriate fixes. As soon as a security update is available, we will include relevant details in the release notes of the affected software versions. -We greatly value the contributions of security researchers and users in ensuring the security of NuclearBoy. Thank you for your dedication to the safety and integrity of our software. +We greatly value the contributions of security researchers and users in ensuring the security of NuclearKid. Thank you for your dedication to the safety and integrity of our software. [Back to README](README.md) diff --git a/docs/conf.py b/docs/conf.py index 3de9cf1..d831456 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,7 +12,7 @@ version_pattern = r'Version\s*=\s*"([^"]+)"' # Read the install.sh file -with open("../install-nuclear-boy.sh", "r") as install_file: +with open("../install-nuclearkid.sh", "r") as install_file: install_contents = install_file.read() # Search for the version using the pattern @@ -25,7 +25,7 @@ # Set a default version if not found version = "Unknown" -project = "NuclearBoy" +project = "NuclearKid" copyright = "2023, Ahnaf Tahmid Chowdhury" author = "Ahnaf Tahmid Chowdhury" release = version @@ -56,13 +56,13 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_book_theme" -html_logo = "../.github/logo/nuclear-boy.svg" -html_title = "NuclearBoy" +html_logo = "../.github/logo/nuclearkid.svg" +html_title = "NuclearKid" html_copy_source = True -html_favicon = "../.github/logo/nuclear-boy.svg" +html_favicon = "../.github/logo/nuclearkid.svg" html_last_updated_fmt = "" html_static_path = ["_static"] -html_css_files = ["nuclear-boy.css"] +html_css_files = ["nuclearkid.css"] html_sidebars = { "**": [ "navbar-logo", @@ -72,7 +72,7 @@ } html_theme_options = { "path_to_docs": "docs", - "repository_url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy", + "repository_url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid", "repository_branch": "develop", "use_edit_page_button": True, "use_source_button": True, @@ -88,14 +88,14 @@ "icon_links": [ { "name": "Release", - "url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases", - "icon": "https://img.shields.io/github/v/release/ahnaf-tahmid-chowdhury/NuclearBoy?style=flat-square&logo=github&label=Release&include_prereleases", + "url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases", + "icon": "https://img.shields.io/github/v/release/ahnaf-tahmid-chowdhury/NuclearKid?style=flat-square&logo=github&label=Release&include_prereleases", "type": "url", }, { "name": "Build and Test", - "url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/blob/develop/.github/workflows/run_build_and_test.yml", - "icon": "https://img.shields.io/github/actions/workflow/status/ahnaf-tahmid-chowdhury/NuclearBoy/run_build_and_test.yml?style=flat-square&logo=githubactions&logoColor=white&label=Build%20and%20Test", + "url": "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/blob/develop/.github/workflows/run_build_and_test.yml", + "icon": "https://img.shields.io/github/actions/workflow/status/ahnaf-tahmid-chowdhury/NuclearKid/run_build_and_test.yml?style=flat-square&logo=githubactions&logoColor=white&label=Build%20and%20Test", "type": "url", }, { diff --git a/docs/contents/importent-notes.md b/docs/contents/importent-notes.md index 3813ef3..c48b466 100644 --- a/docs/contents/importent-notes.md +++ b/docs/contents/importent-notes.md @@ -28,7 +28,7 @@ This script is created to assist users in configuring their Linux-based systems. Open a terminal and navigate to the directory where the script is located. Use the `chmod` command to make the script executable: ```shell - chmod +x install-nuclear-boy.sh + chmod +x install-nuclearkid.sh ``` 4. **Run the Script** @@ -36,7 +36,7 @@ This script is created to assist users in configuring their Linux-based systems. Execute the script using the following command: ```shell - sudo ./install-nuclear-boy.sh + sudo ./install-nuclearkid.sh ``` 5. **Follow On-Screen Prompts** @@ -55,7 +55,7 @@ This script is created to assist users in configuring their Linux-based systems. There is a test script available in the `tests` directory. You may need to install Pytest to test the script. ```sh - nuclear-boy activate + nuclearkid activate pip3 install pytest pytest -ra tests ``` diff --git a/docs/contents/installation-guide.md b/docs/contents/installation-guide.md index 10b6409..d497270 100644 --- a/docs/contents/installation-guide.md +++ b/docs/contents/installation-guide.md @@ -1,45 +1,45 @@ # Installation Guide -Follow these steps to install **NuclearBoy** on your local machine. +Follow these steps to install **NuclearKid** on your local machine. -## Step 1: Download NuclearBoy +## Step 1: Download NuclearKid -You can download the latest release of **NuclearBoy** from the [GitHub releases page](https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/latest). You have multiple options for downloading: +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: ```sh -wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz +wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" -O - | tar -xz ``` ### Using curl: ```sh -curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/archive/refs/tags/v0.1.1.tar.gz" | tar -xz +curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.1.tar.gz" | tar -xz ``` ### Using Git (Download the most recent commit): ```sh -git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy.git" +git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git" ``` -## Step 2: Navigate to the NuclearBoy Directory +## Step 2: Navigate to the NuclearKid Directory ```sh -cd NuclearBoy* +cd NuclearKid* ``` ## Step 3: Make the Installation Script Executable ```sh -chmod +x install-nuclear-boy.sh +chmod +x install-nuclearkid.sh ``` ## Step 4: Run the Installation Script ```sh -./install-nuclear-boy.sh +./install-nuclearkid.sh ``` During the installation process, you'll be prompted for various configuration options. Here are the details of those options: @@ -48,7 +48,7 @@ During the installation process, you'll be prompted for various configuration op 1. **Installation Directory Path**: Set the path where all the software will be installed. You can use the current directory or specify a custom directory. -2. **Environment Name**: Enter a name for the virtual environment that will be created. The default name is `nuclear-boy`, but you can provide a custom name. +2. **Environment Name**: Enter a name for the virtual environment that will be created. The default name is `nuclearkid`, but you can provide a custom name. 3. **Geant4 Data Library Path**: If you choose to install Geant4 data, provide the path for the Geant4 data library. The default is a directory within the virtual environment. @@ -58,14 +58,14 @@ During the installation process, you'll be prompted for various configuration op 6. **Auto Download Cross Sections**: Choose whether to automatically download cross sections. Enter `y` for yes or `n` for no. -Follow the prompts and configure NuclearBoy according to your preferences. Once the installation is complete, you'll have **NuclearBoy** set up and ready to use on your system. +Follow the prompts and configure NuclearKid according to your preferences. Once the installation is complete, you'll have **NuclearKid** set up and ready to use on your system. ## Quick Installation You can also provide the configuration options directly from the command line. Use the following format: ```sh -./install-nuclear-boy.sh -d \ +./install-nuclearkid.sh -d \ -e \ -g \ -c @@ -76,7 +76,7 @@ You can also provide the configuration options directly from the command line. U The installer script provides a list of recommended Python packages in the `packages.txt` file. These packages complement the functionality of the installed software. To install them, use: ```sh -nuclear-boy activate +nuclearkid activate pip3 install -r packages.txt --default-timeout=0 ``` diff --git a/docs/contents/methodology.md b/docs/contents/methodology.md index 5933262..2d1a0c2 100644 --- a/docs/contents/methodology.md +++ b/docs/contents/methodology.md @@ -68,6 +68,6 @@ To simplify the usage of the installed tools, the script creates an executable p ## 10. Add to Path -Finally, the script ensures that the **NuclearBoy** installation directory is added to the user's `PATH` environment variable, making it easier to access the installed tools from the command line. +Finally, the script ensures that the **NuclearKid** installation directory is added to the user's `PATH` environment variable, making it easier to access the installed tools from the command line. The installation process described above ensures that the required software components and dependencies are properly configured for nuclear engineering and simulation tasks, providing users with a complete environment for their work. \ No newline at end of file diff --git a/docs/contents/usage.md b/docs/contents/usage.md index 5f5a04d..2fdbef8 100644 --- a/docs/contents/usage.md +++ b/docs/contents/usage.md @@ -2,22 +2,22 @@ Certainly! Here's the provided information in more detail using Markdown format: # Activation and Usage -The **NuclearBoy** is a powerful package manager toolkit, specifically crafted for managing and updating various nuclear physics components and libraries. This guide will walk you through the activation, usage, and available commands of this package manager. +The **NuclearKid** is a powerful package manager toolkit, specifically crafted for managing and updating various nuclear physics components and libraries. This guide will walk you through the activation, usage, and available commands of this package manager. ## Installation -Before using the **NuclearBoy**, you need to install it. Once the installation is complete, the script will create a program file named after the specified environment name, such as `nuclear-boy`. +Before using the **NuclearKid**, you need to install it. Once the installation is complete, the script will create a program file named after the specified environment name, such as `nuclearkid`. ## Commands -**NuclearBoy** supports the following commands: +**NuclearKid** supports the following commands: ### Display Help To display the help message, use the `-h` or `--help` flag: ```sh -nuclear-boy -h +nuclearkid -h ``` ### Display Version @@ -25,63 +25,63 @@ nuclear-boy -h To display the version information, use the `-V` or `--version` flag: ```sh -nuclear-boy -V +nuclearkid -V ``` ### Activate Environment -To activate the **NuclearBoy** environment, simply use the `activate` command: +To activate the **NuclearKid** environment, simply use the `activate` command: ```sh -nuclear-boy activate +nuclearkid activate ``` ### Deactivate Environment -To deactivate the **NuclearBoy** environment, use the `deactivate` command: +To deactivate the **NuclearKid** environment, use the `deactivate` command: ```sh -nuclear-boy deactivate +nuclearkid deactivate ``` ### Update Components You can update specific components individually or update all components at once. Here are the available update commands: -- Update NuclearBoy (Core): +- Update NuclearKid (Core): ```sh -nuclear-boy update core +nuclearkid update core ``` - Update Geant4 to the latest version: ```sh -nuclear-boy update geant4 +nuclearkid update geant4 ``` - Update DAGMC to the latest version: ```sh -nuclear-boy update dagmc +nuclearkid update dagmc ``` - Update OpenMC to the latest version: ```sh -nuclear-boy update openmc +nuclearkid update openmc ``` - Update PyNE to the latest version: ```sh -nuclear-boy update pyne +nuclearkid update pyne ``` -- Update all components (NuclearBoy, Geant4, DAGMC, OpenMC, and PyNE): +- Update all components (NuclearKid, Geant4, DAGMC, OpenMC, and PyNE): ```sh -nuclear-boy update all +nuclearkid update all ``` ### Set Cross-Section Data Library @@ -91,69 +91,69 @@ You can set the path for the cross-section data library using the `endf` command - ENDF/B-VII.0 (70): ```sh -nuclear-boy endf endfb70 +nuclearkid endf endfb70 ``` - ENDF/B-VII.1 (71): ```sh -nuclear-boy endf endfb71 +nuclearkid endf endfb71 ``` - ENDF/B-VIII.0/X (80X): ```sh -nuclear-boy endf lib80x +nuclearkid endf lib80x ``` -### Uninstall NuclearBoy +### Uninstall NuclearKid -To completely uninstall **NuclearBoy**, use the `uninstall` command: +To completely uninstall **NuclearKid**, use the `uninstall` command: ```sh -nuclear-boy uninstall +nuclearkid uninstall ``` ## General Usage -The general usage format for **NuclearBoy** is as follows: +The general usage format for **NuclearKid** is as follows: ```sh -nuclear-boy [options] +nuclearkid [options] ``` ## Examples -Here are some examples of how to use the **NuclearBoy** commands: +Here are some examples of how to use the **NuclearKid** commands: -- Activate the NuclearBoy environment: +- Activate the NuclearKid environment: ```sh -nuclear-boy activate +nuclearkid activate ``` - Update Geant4 to the latest version: ```sh -nuclear-boy update geant4 +nuclearkid update geant4 ``` - Update all components: ```sh -nuclear-boy update all +nuclearkid update all ``` - Set the cross-section data library to ENDF/B-VII.0 (70): ```sh -nuclear-boy endf endfb70 +nuclearkid endf endfb70 ``` -- Uninstall NuclearBoy: +- Uninstall NuclearKid: ```sh -nuclear-boy uninstall +nuclearkid uninstall ``` -Feel free to use these commands to manage and update your nuclear physics components efficiently with the **NuclearBoy** package manager! \ No newline at end of file +Feel free to use these commands to manage and update your nuclear physics components efficiently with the **NuclearKid** package manager! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 836fd00..2353b0c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ -# Welcome to NuclearBoy +# Welcome to NuclearKid -## 📦 What is NuclearBoy? -**NuclearBoy** 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. +## 📦 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/ [openmc]: https://docs.openmc.org/en/stable/ @@ -11,23 +11,23 @@ ## 🚀 How to Get Started? - Download the latest release. - Extract it onto your local machine. -- Navigate to the NuclearBoy directory. -- Execute the `install-nuclear-boy.sh` script. +- Navigate to the NuclearKid directory. +- Execute the `install-nuclearkid.sh` script. - Follow the prompts to customize your installation. ## 🛠 Installation Options -**NuclearBoy** 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. +**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 -**NuclearBoy** 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! +**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, **NuclearBoy** 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. It compiles packages from source, which can be time-consuming. Our team is actively working on creating binary packages for internal components. ## 📜 License -**NuclearBoy** is distributed under the [MIT License](contents/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. diff --git a/install-nuclear-boy.sh b/install-nuclear-boy.sh index 10b0995..cca73f7 100755 --- a/install-nuclear-boy.sh +++ b/install-nuclear-boy.sh @@ -127,10 +127,10 @@ set_install_directory() { set_env_name() { if [ -z "$env_name" ]; then - read -p "Enter environment name (or press enter for default 'nuclear-boy'): " env_name + read -p "Enter environment name (or press enter for default 'nuclearkid'): " env_name if [ -z "$env_name" ]; then - env_name="nuclear-boy" + env_name="nuclearkid" echo "Using default environment name: $env_name" else echo "Using custom environment name: $env_name" @@ -223,13 +223,13 @@ setup_python_env() { core_old_version=$(cat ${env_dir}/var/log/Version.id) core_new_version=$Version while true; do - read -p "Update NuclearBoy from $core_old_version to $core_new_version? (y/n): " -n 1 -r + read -p "Update NuclearKid from $core_old_version to $core_new_version? (y/n): " -n 1 -r echo if [[ $REPLY =~ ^[Yy]$ ]]; then source $env_dir/bin/activate break elif [[ $REPLY =~ ^[Nn]$ ]]; then - read -p "Do you want to delete the previous NuclearBoy and create a new one? (y/n): " -n 1 -r + read -p "Do you want to delete the previous NuclearKid and create a new one? (y/n): " -n 1 -r echo if [[ $REPLY =~ ^[Yy]$ ]]; then rm -rf "${env_dir}" @@ -890,40 +890,40 @@ __${env_name}_update_pyne() { __${env_name}_update_core(){ echo "----------------------" - echo "Updating NuclearBoy..." + echo "Updating NuclearKid..." echo "----------------------" # Get the latest commit hash of the develop branch - core_new_version=\$(git ls-remote https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy.git develop | awk '{print \$1}') + core_new_version=\$(git ls-remote https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git develop | awk '{print \$1}') # Read the previously stored commit hash from the file core_old_version=\$(cat ${env_dir}/var/log/Version.id) # Compare the new and old commit hashes if [[ "\$core_new_version" == "\$core_old_version" ]]; then - echo "NuclearBoy is already up to date." + echo "NuclearKid is already up to date." else while true; do - echo "Update NuclearBoy from \$core_old_version to \$core_new_version? (y/n): " + echo "Update NuclearKid from \$core_old_version to \$core_new_version? (y/n): " read -r REPLY if [[ \$REPLY =~ ^[Yy]\$ ]]; then # Get the current working directory current_working_dir=\$(pwd) - # Navigate to the existing NuclearBoy installation directory + # Navigate to the existing NuclearKid installation directory cd ${env_dir} # Make a new temporary directory mkdir -p .tmp cd .tmp - # Remove the existing NuclearBoy repository if it exists - rm -rf NuclearBoy - # Clone the latest version of the NuclearBoy repository - git clone https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy.git NuclearBoy - cd NuclearBoy + # Remove the existing NuclearKid repository if it exists + rm -rf NuclearKid + # Clone the latest version of the NuclearKid repository + git clone https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git NuclearKid + cd NuclearKid # Run Setup - ./install-nuclear-boy.sh -d ${install_dir} -e ${env_name} + ./install-nuclearkid.sh -d ${install_dir} -e ${env_name} # Remove the temporary directory rm -rf ${env_dir}/.tmp cd \$current_working_dir break elif [[ \$REPLY =~ ^[Nn]\$ ]]; then - echo "NuclearBoy update cancelled." + echo "NuclearKid update cancelled." break else echo "Error: Invalid input." @@ -960,7 +960,7 @@ __${env_name}_uninstall(){ echo "Removing ${env_name} from your shell." local config_file="\$1" if [ -f "\$config_file" ]; then - sed -i '/#<<< NuclearBoy >>>#/,/#>>> NuclearBoy <<<#/d' "\$config_file" + sed -i '/#<<< NuclearKid >>>#/,/#>>> NuclearKid <<<#/d' "\$config_file" echo "Removed ${env_name} from \$config_file." fi } @@ -977,7 +977,7 @@ __${env_name}_uninstall(){ } __${env_name}_help() { - echo "NuclearBoy: Package Manager for Nuclear Engineering Development + echo "NuclearKid: Package Manager for Nuclear Engineering Development Commands: @@ -986,12 +986,12 @@ Commands: -V, --version Display version - activate Activate the NuclearBoy environment + activate Activate the NuclearKid environment - deactivate Deactivate the NuclearBoy environment + deactivate Deactivate the NuclearKid environment update Update component - - core: Update NuclearBoy + - core: Update NuclearKid - geant4: Update Geant4 to the latest version - openmc: Update OpenMC to the latest version - dagmc: Update DAGMC to the latest version @@ -1003,7 +1003,7 @@ Commands: - endfb71: ENDF/B-VII.1 (71) - lib80x: ENDF/B-VIII.0/X (80X) - uninstall Uninstall the NuclearBoy toolkit + uninstall Uninstall the NuclearKid toolkit Usage: @@ -1012,12 +1012,12 @@ Usage: Note: - - Use 'activate' to activate the NuclearBoy environment. - - Use 'deactivate' to deactivate the NuclearBoy environment. + - Use 'activate' to activate the NuclearKid environment. + - Use 'deactivate' to deactivate the NuclearKid environment. - Use 'update' with specific components to update them individually. - Use 'update all' to update all components. - Use 'endf ' to set the cross-section data library path. - - Use 'uninstall' to completely uninstall the NuclearBoy toolkit. + - Use 'uninstall' to completely uninstall the NuclearKid toolkit. Examples: @@ -1028,11 +1028,11 @@ Examples: ${env_name} uninstall -Project Home: https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy" +Project Home: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid" } __${env_name}_version(){ - echo "NuclearBoy version ${Version}" + echo "NuclearKid version ${Version}" } ${env_name}() { @@ -1066,14 +1066,14 @@ add_to_shell() { backup_file="$backup_dir/$(basename $config_file)_$(date +%Y%m%d%H%M%S)" cp "$config_file" "$backup_file" # Append to the config file if not already present - if ! grep -q "#<<< NuclearBoy >>>#" "$config_file" && ! grep -q "#>>> NuclearBoy <<<#" "$config_file"; then + if ! grep -q "#<<< NuclearKid >>>#" "$config_file" && ! grep -q "#>>> NuclearKid <<<#" "$config_file"; then echo "Adding to $config_file" cat >>"$config_file" <>># +#<<< NuclearKid >>># if [ -f "${env_dir}/${env_name}" ]; then source ${env_dir}/${env_name} fi -#>>> NuclearBoy <<<# +#>>> NuclearKid <<<# EOF fi @@ -1092,7 +1092,7 @@ main() { detect_os detect_version_id echo - echo -e "\033[1mWelcome to the NuclearBoy installer!\033[0m" + echo -e "\033[1mWelcome to the NuclearKid installer!\033[0m" echo "This package manager sets up a development environment for nuclear physics simulations and calculations. It automates the installation of various packages @@ -1118,8 +1118,8 @@ for running nuclear physics simulations and analyses." create_program_file add_to_shell echo "===============================================" - echo "NuclearBoy installation finished" - echo "To activate NuclearBoy in your terminal type:" + echo "NuclearKid installation finished" + echo "To activate NuclearKid in your terminal type:" echo "${env_name} activate" echo "Recommended packages can be installed through:" echo "pip3 install -r packages.txt --default-timeout=0" From de2bc7e3c099b51043d05297a1fd19349c8492ed Mon Sep 17 00:00:00 2001 From: Ahnaf Tahmid Chowdhury Date: Wed, 6 Sep 2023 10:56:37 +0600 Subject: [PATCH 2/4] NuclearBoy -> NuclearKid --- LICENSE | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/LICENSE b/LICENSE index 4ec4125..f30d4f3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,8 @@ # MIT License -Copyright (c) 2023 Ahnaf Tahmid Chowdhury +Copyright (c) 2023 NuclearKid -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: ## Conditions: @@ -12,9 +10,4 @@ The above copyright notice and this permission notice shall be included in all c ## Warranty: -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. From c3f04223e4c6e2f5e4d764566f4e8d7dbfedd34f Mon Sep 17 00:00:00 2001 From: Ahnaf Tahmid Chowdhury Date: Wed, 6 Sep 2023 11:07:59 +0600 Subject: [PATCH 3/4] NuclearBoy -> NuclearKid --- CHANGELOG.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41e05d4..76386b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # Changelog -## Future Features +## [v0.1.2] - 06/09/2023 ### Added - Sphinx documentation. (#6 #7) @@ -9,6 +9,11 @@ ### Changed - Remove ethicalads. (#8 #9) +- Rename `nuclearboy` to `nuclearkid`. (#10) +- Rename NuclearBoy to NuclearKid. (#10) + + +[v0.1.2]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.1.2 ## [v0.1.1] - 01/09/2023 @@ -30,7 +35,7 @@ - Other minor improvements, optimizations, and code refinements.(#4) -[v0.1.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/tag/v0.1.1 +[v0.1.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.1.1 ## [v0.1.0] - 01/09/2023 @@ -80,7 +85,7 @@ ### Deprecated - Deprecated the old method of environment activation and program usage. (#3) -[v0.1.0]: https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/tag/v0.1.0 +[v0.1.0]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.1.0 @@ -105,4 +110,4 @@ ### Fixed - Set cython<3 (#2) -[v0.0.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/tag/v0.0.1 \ No newline at end of file +[v0.0.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.0.1 \ No newline at end of file From 72ba3336093cac8fc5fc27a29aa132c920bf8bd5 Mon Sep 17 00:00:00 2001 From: Ahnaf Tahmid Chowdhury Date: Wed, 6 Sep 2023 11:10:06 +0600 Subject: [PATCH 4/4] NuclearBoy -> NuclearKid --- install-nuclear-boy.sh => install-nuclearkid.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename install-nuclear-boy.sh => install-nuclearkid.sh (100%) mode change 100755 => 100644 diff --git a/install-nuclear-boy.sh b/install-nuclearkid.sh old mode 100755 new mode 100644 similarity index 100% rename from install-nuclear-boy.sh rename to install-nuclearkid.sh