Skip to content

Commit

Permalink
Merge pull request #10 from ahnaf-tahmid-chowdhury/nuclearkid
Browse files Browse the repository at this point in the history
Nuclearkid
  • Loading branch information
ahnaf-tahmid-chowdhury authored Sep 6, 2023
2 parents 3677ea1 + 72ba333 commit 468a9f6
Show file tree
Hide file tree
Showing 19 changed files with 184 additions and 191 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 NuclearBoy
about: Report a bug or issue to enhance the quality of NuclearKid
title: '[BUG] Concise description of the bug'
labels: bug
assignees: ''
Expand Down Expand Up @@ -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
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 NuclearBoy
about: Suggest enhancements or new features to elevate NuclearKid
title: '[FEATURE] Concise description of the feature'
labels: enhancement
assignees: ''
Expand Down
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 NuclearBoy for review and inclusion
about: Submit changes to NuclearKid for review and inclusion
title: '[PR] Concise description of your changes'
labels: enhancement
assignees: ''
Expand Down
16 changes: 8 additions & 8 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-nuclear-boy.sh'
- 'install-nuclearkid.sh'
- 'tests/**'

jobs:
Expand All @@ -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
13 changes: 9 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# Changelog


## Future Features
## [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)


[v0.1.2]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.1.2


## [v0.1.1] - 01/09/2023
Expand All @@ -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
Expand Down Expand Up @@ -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



Expand All @@ -105,4 +110,4 @@
### Fixed
- Set cython<3 (#2)

[v0.0.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearBoy/releases/tag/v0.0.1
[v0.0.1]: https://github.com/ahnaf-tahmid-chowdhury/NuclearKid/releases/tag/v0.0.1
8 changes: 4 additions & 4 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
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,
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.
Expand Down
4 changes: 2 additions & 2 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 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

Expand Down Expand Up @@ -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.

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 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

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 **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/<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-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`

Expand All @@ -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
Expand Down
20 changes: 4 additions & 16 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,25 +1,13 @@
# 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:

- 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,
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.
Loading

0 comments on commit 468a9f6

Please sign in to comment.