Skip to content

Commit

Permalink
Move ownership to nukehub-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
ahnaf-tahmid-chowdhury committed Nov 4, 2023
1 parent 1797a16 commit ea1462b
Show file tree
Hide file tree
Showing 22 changed files with 184 additions and 175 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug Report
about: Report a bug or issue to enhance the quality of NuclearKid
about: Report a bug or issue to enhance the quality of NukeBox
title: "[BUG] Concise description of the bug"
labels: bug
assignees: ""
Expand Down Expand Up @@ -33,7 +33,7 @@ If applicable, attach relevant screenshots, error logs, or code snippets to prov
**Environment Information:**

- Operating System: [e.g. Ubuntu 22.04]
- NuclearKid Version: [e.g. 0.1.0]
- NukeBox 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
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature Request
about: Suggest enhancements or new features to elevate NuclearKid
about: Suggest enhancements or new features to elevate NukeBox
title: "[FEATURE] Concise description of the feature"
labels: enhancement
assignees: ""
Expand Down
2 changes: 1 addition & 1 deletion .github/logo/nuclearkid.svg → .github/logo/nukebox.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Pull Request
about: Submit changes to NuclearKid for review and inclusion
about: Submit changes to NukeBox for review and inclusion
title: "[PR] Concise description of your changes"
labels: enhancement
assignees: ""
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/run_build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
- develop
paths:
- '.github/workflows/run_build_and_test.yml'
- 'install-nuclearkid.sh'
- 'install-nukebox.sh'
- 'tests/**'

jobs:
Expand All @@ -35,16 +35,16 @@ jobs:
with:
python-version: 3.11

- name: Install NuclearKid
- name: Install NukeBox
run: |
./install-nuclearkid.sh -d ${GITHUB_WORKSPACE} \
-e nuclearkid \
-g ${GITHUB_WORKSPACE}/nuclearkid/G4Data \
-c ${GITHUB_WORKSPACE}/nuclearkid/CrossSectionData
./install-nukebox.sh -d ${GITHUB_WORKSPACE} \
-e nukebox \
-g ${GITHUB_WORKSPACE}/nuke/G4Data \
-c ${GITHUB_WORKSPACE}/nuke/CrossSectionData
- name: Run tests
run: |
source ${GITHUB_WORKSPACE}/nuclearkid/nuclearkid
source ${GITHUB_WORKSPACE}/nuke/nuke
nuclearkid activate
python -m pip install pytest
python -m pytest -ra tests
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## [v0.1.3] - 06/09/2023

### Changed
- Move ownership to `nukehub-dev`.

## [v0.1.2] - 06/09/2023

Expand Down
12 changes: 6 additions & 6 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cff-version: 1.2.0
title: >-
NuclearKid: Package Manager for Nuclear Engineering
NukeBox: Package Manager for Nuclear Engineering
Development
message: Nuclear Physics Simulation Toolkit
type: software
Expand All @@ -13,9 +13,9 @@ authors:
identifiers:
- type: doi
value: 10.5281/zenodo.8307492
repository-code: 'https://github.com/ahnaf-tahmid-chowdhury/NuclearKid'
repository-code: 'https://github.com/nukehub-dev/NukeBox'
abstract: >-
NuclearKid is a versatile package manager tailored for
NukeBox 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
Expand All @@ -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,
NuclearKid simplifies the often complex task of setting up
NukeBox 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.
Expand All @@ -38,5 +38,5 @@ keywords:
- Scientific Computing
- Simulation
license: MIT
version: 0.1.2
date-released: '2023-09-01'
version: 0.1.3
date-released: '2023-11-04'
6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code of Conduct

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.
We, the contributors and maintainers of the NukeBox 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

Expand Down Expand Up @@ -28,13 +28,13 @@ Unacceptable behaviors include, but are not limited to:

## Consequences of Unacceptable Behavior

Unacceptable behavior will not be tolerated within the NuclearKid community. Anyone asked to stop unacceptable behavior is expected to comply immediately.
Unacceptable behavior will not be tolerated within the NukeBox 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.

## Reporting

If you witness or experience behavior that violates this Code of Conduct, please contact the project maintainers at [Ahnaf Tahmid Chowdhury](mailto:[email protected]). All reports will be kept confidential.
If you witness or experience behavior that violates this Code of Conduct, please contact the [Admin](mailto:[email protected]). All reports will be kept confidential.

## Attribution

Expand Down
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to NuclearKid
# Contributing to NukeBox

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.
Thank you for your interest in contributing to **NukeBox**! We appreciate your efforts to improve the project and make it more useful for the nuclear physics community.

## Code of Conduct

Expand All @@ -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 **NuclearKid**, we want to know! Please follow these steps:
If you encounter a bug while using **NukeBox**, we want to know! Please follow these steps:

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].
1. Check the [existing issues](https://github.com/nukehub-dev/NukeBox/issues) to see if the bug has already been reported.
2. If the bug is new, [open a new issue](https://github.com/nukehub-dev/NukeBox/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/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].
1. Review the [existing issues](https://github.com/nukehub-dev/NukeBox/issues) to avoid duplicate suggestions.
2. If your idea is new, [open a new issue](https://github.com/nukehub-dev/NukeBox/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 **NuclearKid**. Follow these steps to submit a pull request:
Contributions from the community help us grow and improve **NukeBox**. 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/NuclearKid/compare) using the provided [pull request template][pull-request-template].
4. [Open a new pull request](https://github.com/nukehub-dev/NukeBox/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/NuclearKid/fork).
1. Fork the [repository](https://github.com/nukehub-dev/NukeBox/fork).
1. Clone your fork of the repository:
```sh
git clone https://github.com/<USERNAME>/<REPOSITORY_NAME>.git`
```
2. Navigate to the project directory: `cd <REPOSITORY_NAME>`
3. Check out development branch: `git checkout develop`
4. Run the script: `./install-nuclearkid.sh` and install NuclearKid
4. Run the script: `./install-nukebox.sh` and install NukeBox
5. Install dependencies: `pip install -r packages.txt`
6. Run tests: `pytest -ra tests`

Expand All @@ -55,9 +55,9 @@ Please adhere to the established coding guidelines to maintain consistency acros
## License
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.
By contributing to **NukeBox**, 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 **NuclearKid**!
Thank you for contributing to **NukeBox**!
[bug-report-template]: .github/ISSUE_TEMPLATE/bug-report-template.md
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2023 NuclearKid
Copyright (c) 2023 NukeBox

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:

Expand Down
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# <img src=".github/logo/nuclearkid.svg" alt="" style="height: 64px">NuclearKid</h1>
# <img src=".github/logo/nuclearkid.svg" alt="" style="height: 64px">NukeBox</h1>

![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
![Build and Test](https://img.shields.io/github/actions/workflow/status/nukehub-dev/NukeBox/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/NuclearKid?style=flat-square&logo=github&label=Release&include_prereleases)
![Release](https://img.shields.io/github/v/release/nukehub-dev/NukeBox?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.
Expand All @@ -14,26 +14,26 @@ 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/NuclearKid/releases/latest) and extract it to your local machine.
1. Download the [latest release](https://github.com/nukehub-dev/NukeBox/releases/latest) and extract it to your local machine.

**Using wget:**
```sh
wget "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" -O - | tar -xz
wget "https://github.com/nukehub-dev/NukeBox/archive/refs/tags/v0.1.3.tar.gz" -O - | tar -xz

```
**Using curl:**
```sh
curl -L "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/archive/refs/tags/v0.1.2.tar.gz" | tar -xz
curl -L "https://github.com/nukehub-dev/NukeBox/archive/refs/tags/v0.1.3.tar.gz" | tar -xz
```
**Using Git:** (Download the most recent commit)
```sh
git clone "https://github.com/ahnaf-tahmid-chowdhury/NuclearKid.git"
git clone "https://github.com/nukehub-dev/NukeBox.git"
```

2. Go to the NuclearKid directory.
2. Go to the NukeBox directory.

```sh
cd NuclearKid*
cd NukeBox*
```

3. Make the `install-nuclearkid.sh` script executable.
Expand Down Expand Up @@ -133,7 +133,7 @@ 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 NuclearKid directory to the user's `PATH` environment variable.
The script adds the NukeBox directory to the user's `PATH` environment variable.

## Activation and Usage

Expand All @@ -142,49 +142,49 @@ Once the installation is complete, the script will create a program file named a
**Commands:**
- `-h` or `--help`: Display help
- `-V` or `--version`: Display version
- `activate`: Activate the NuclearKid environment
- `deactivate`: Deactivate the NuclearKid environment
- `activate`: Activate the NukeBox environment
- `deactivate`: Deactivate the NukeBox environment
- `update <module>`: Update component
- `core`: Update NuclearKid
- `core`: Update NukeBox
- `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 (NuclearKid, Geant4, DAGMC, OpenMC, and PyNE)
- `all`: Update all components (NukeBox, Geant4, DAGMC, OpenMC, and PyNE)
- `endf <library>`: 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 NuclearKid toolkit
- `uninstall`: Uninstall the NukeBox toolkit

**Usage:**
```sh
nuclearkid <command> [options]
nuke <command> [options]
```

**Note:**
- Use `activate` to activate the NuclearKid environment.
- Use `deactivate` to deactivate the NuclearKid environment.
- Use `activate` to activate the NukeBox environment.
- Use `deactivate` to deactivate the NukeBox environment.
- Use `update` with specific components to update them individually.
- Use `update all` to update all components.
- Use `endf <library>` to set the cross-section data library path.
- Use `uninstall` to completely uninstall the NuclearKid toolkit.
- Use `uninstall` to completely uninstall the NukeBox toolkit.

**Examples:**
```sh
nuclearkid activate
nuclearkid update geant4
nuclearkid update all
nuclearkid endf endfb70
nuclearkid uninstall
nuke activate
nuke update geant4
nuke update all
nuke endf endfb70
nuke uninstall
```

## Recommended Packages

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
nuclearkid activate
nuke activate
pip3 install -r packages.txt --default-timeout=0
```

Expand All @@ -203,14 +203,15 @@ This project is licensed under the [MIT License](LICENSE).

## Disclaimer

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.
The NukeBox 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

Contributions to this project are welcome. If you find any issues or have improvements to suggest, feel free to open a GitHub issue or create a pull request. For more information, check out the [CONTRIBUTING](CONTRIBUTING.md) page.

## Contact

For any questions or inquiries, please contact the maintainers of this project:
For any questions or inquiries, please contact through:

- [Ahnaf Tahmid Chowdhury](https://github.com/ahnaf-tahmid-chowdhury)
- GitHub: [nukehub-dev](https://github.com/nukehub-dev)
- NukeTalk: [https://talk.nukehub.org](https://talk.nukehub.org)
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Reporting Security Vulnerabilities

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:
At NukeBox, 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 NukeBox, we kindly request that you follow responsible disclosure practices by adhering to the following guidelines:

### Reporting Process

Expand All @@ -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 NuclearKid. 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 NukeBox. Thank you for your dedication to the safety and integrity of our software.

[Back to README](README.md)
File renamed without changes.
Loading

0 comments on commit ea1462b

Please sign in to comment.