Skip to content

Commit

Permalink
Merge branch 'develop' into alpha-test-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
MicahGale committed Dec 16, 2024
2 parents b2b009b + d414c18 commit f3b1591
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 50 deletions.
46 changes: 2 additions & 44 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,6 @@ jobs:
- run: pip install . montepy[develop]
- run: python -m pytest

build-pages:
needs: [last-minute-test, build-packages]
environment:
name: github-pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
ref: main
- uses: actions/setup-python@v5
with:
python-version: 3.12
- run: pip install --user . montepy[doc]
- run: cd doc && make html
- uses: actions/configure-pages@v4
- uses: actions/upload-pages-artifact@v3
with:
name: deploy-pages
path: doc/build/html/

build-packages:
name: Build, sign, and release packages on github
Expand Down Expand Up @@ -87,34 +66,13 @@ jobs:
dist/*.tar.gz
dist/*.whl
deploy-pages:
permissions:
contents: read
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: [build-pages, last-minute-test]
runs-on: ubuntu-latest
steps:
- run: ls -l
- uses: actions/download-artifact@v4
with:
name: deploy-pages
- run: ls -l
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
artifact_name: deploy-pages

deploy-test-pypi:
environment:
name: test-pypi
url: https://test.pypi.org/p/montepy # Replace <package-name> with your PyPI project name
needs: [deploy-pages, build-packages]
needs: [build-packages]
permissions:
contents: read
id-token: write
Expand All @@ -133,7 +91,7 @@ jobs:
environment:
name: pypi
url: https://pypi.org/p/montepy # Replace <package-name> with your PyPI project name
needs: [deploy-pages, deploy-test-pypi, build-packages]
needs: [deploy-test-pypi, build-packages]
permissions:
contents: read
id-token: write
Expand Down
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@


[![PyPI version](https://badge.fury.io/py/montepy.svg)](https://badge.fury.io/py/montepy)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/montepy.svg)](https://anaconda.org/conda-forge/montepy)
[![Docs Deployment](https://github.com/idaholab/MontePy/actions/workflows/deploy.yml/badge.svg?branch=main)](https://www.montepy.org/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/montepy.svg)](https://pypi.org/project/montepy/)

Expand All @@ -24,7 +25,7 @@ pip install montepy
```

For more complicated setups
see the [Installing section in the user guide](https://www.montepy.org/starting.html#installing).
see the [Installing section in the user guide](https://www.montepy.org/en/stable/starting.html#installing).


## User Documentation
Expand All @@ -42,9 +43,9 @@ and the Python API documentation.
* Can parse all surface types except macrobody facets ([Issue #354](https://github.com/idaholab/MontePy/issues/354)).
* Can read and write out all other MCNP inputs, even if it doesn't not understand them
* Attempts to write out the MCNP problem verbatim, even matching the original user formatting. (See some of the [open issues](https://github.com/idaholab/MontePy/issues).)
* Can quickly [access cells, surfaces, and materials by their numbers](https://www.montepy.org/starting.html#collections-are-accessible-by-number). For example: `cell = problem.cells[105]`.
* Can quickly update cell parameters, [such as importances](https://www.montepy.org/starting.html#setting-cell-importances). For example `cell.importance.neutron = 2.0`.
* Can easily [create universes, and fill other cells with universes](https://www.montepy.org/starting.html#universes).
* Can quickly [access cells, surfaces, and materials by their numbers](https://www.montepy.org/en/stable/starting.html#collections-are-accessible-by-number). For example: `cell = problem.cells[105]`.
* Can quickly update cell parameters, [such as importances](https://www.montepy.org/en/stable/starting.html#setting-cell-importances). For example `cell.importance.neutron = 2.0`.
* Can easily [create universes, and fill other cells with universes](https://www.montepy.org/en/stable/starting.html#universes).
* Currently has over 550 test cases.


Expand Down Expand Up @@ -134,7 +135,7 @@ Another honorable mention that doesn't replicate the features of MontePy,
So MontePy doesn't do what you want?
Add an issue here with the "feature request" tag.
The system is very modular and you should be able to develop it pretty quickly.
Read the [developer's guide](https://www.montepy.org/developing.html) for more details.
Read the [developer's guide](https://www.montepy.org/en/stable/developing.html) for more details.
If you have any questions feel free to ask [@micahgale](mailto:mgale@montepy.org).

## Citation
Expand Down
1 change: 1 addition & 0 deletions doc/source/dev_checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,4 @@ For a deployment you need to:
#. Manually merge onto main without creating a new commit.
This is necessary because there's no way to do a github PR that will not create a new commit, which will break setuptools_scm.
#. Update the release notes on the draft release, and finalize it on GitHub.
#. Update the `Conda feedstock and deploy <https://github.com/conda-forge/montepy-feedstock>`_.

0 comments on commit f3b1591

Please sign in to comment.