Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Setup package structure to follow the Scientific Python Library Development Guide #103

Merged
merged 25 commits into from
Dec 1, 2023

Conversation

lsetiawan
Copy link
Collaborator

Overview

This PR refactors the package structure to follow the Scientific Python Library Development Guide. The following changes occured: uw-ssec#1 and uw-ssec#15. To highlight, we've added codespaces, continuous deployment, auto versioning, pre-commit, and many more!

lsetiawan and others added 3 commits November 27, 2023 14:20
* Update README.md

Add SSEC badge

* Move project to src/ directory

* Update Codespaces link

* Update README.md

* Update README.md

Update Codespaces link

* Update devcontainer

* ci: Create cd.yml for building and pushing package

* Update caustic name to caustics

* Add PyLint and Black formatting features to devcon

* Closes issue #16

* Updated test/ -> tests/

* Move project to src/ directory

* Update README.md

* Update README.md

Update Codespaces link

* Create noxfile.py

* Add .readthedocs.yaml

* Create .git_archival.txt

* Create .gitattributes

* Create .pre-commit-config.yaml

* Add sphinx and myst-parser support

* style: pre-commit fixes

* Update docs

* style: pre-commit fixes

* Update .github Actions

* Update environment.yml
- Add jupyter-book

* Create CONTRIBUTING.md

* Update README.md

* chore: resolve conflicts

* chore: Remove sources

* test: remove test lenses

* test: fix test_simulator

* chore: Set min python to 3.9

* fix: change pytest to point to tests/

* build: update dep list to use reqs.txt

* ci: Don't fail fast

* chore(deps): Pin astropy < 6

* fix: change instances of caustic to caustics

* fix: Perform pre-commit

* fix: update path to conf.py

* update README

* style: pre-commit fixes

* docs: Add contributor graph

* chore: Setup dynamic versioning

* ci: Update fetch depth to 0 to get correct version

* Update README.md

Update Codespaces button to new repo name

---------

Co-authored-by: Cordero Core <127983572+uwcdc@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* ci: update yaml configuration for CI

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Copy link
Member

@ConnorStoneAstro ConnorStoneAstro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really impressive!

.github/workflows/cd.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
src/caustics/lenses/pixelated_convergence.py Outdated Show resolved Hide resolved
tests/test_parametrized.py Outdated Show resolved Hide resolved
tests/test_parametrized.py Outdated Show resolved Hide resolved
Added issue to contribution section
Copy link

codecov bot commented Nov 28, 2023

Codecov Report

Attention: 20 lines in your changes are missing coverage. Please review.

Comparison is base (d6ff524) 76.94% compared to head (3582316) 88.41%.
Report is 19 commits behind head on dev.

Files Patch % Lines
src/caustics/lenses/base.py 80.00% 8 Missing ⚠️
src/caustics/parametrized.py 85.71% 3 Missing ⚠️
src/caustics/sims/lens_source.py 82.35% 3 Missing ⚠️
src/caustics/lenses/multiplane.py 95.91% 2 Missing ⚠️
src/caustics/cosmology.py 94.73% 1 Missing ⚠️
src/caustics/lenses/utils.py 0.00% 1 Missing ⚠️
src/caustics/namespace_dict.py 75.00% 1 Missing ⚠️
src/caustics/parameter.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              dev     #103       +/-   ##
===========================================
+ Coverage   76.94%   88.41%   +11.47%     
===========================================
  Files          39       35        -4     
  Lines        2030     1770      -260     
===========================================
+ Hits         1562     1565        +3     
+ Misses        468      205      -263     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.github/workflows/cd.yml Outdated Show resolved Hide resolved
.github/workflows/cd.yml Outdated Show resolved Hide resolved
.github/workflows/cd.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
lsetiawan and others added 8 commits November 28, 2023 09:24
Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com>
Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com>
Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com>
Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com>
@lsetiawan
Copy link
Collaborator Author

Really impressive!

Thank you for that feedback @ConnorStoneAstro 😊

@uwcdc did an amazing job getting all of this stuff together

docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
noxfile.py Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@AlexandreAdam AlexandreAdam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great!

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@lsetiawan lsetiawan merged commit 8a50627 into Ciela-Institute:dev Dec 1, 2023
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants