Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions .badgery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@ cards:
- group: Tests
type: gh_action
title: Code/package tests (GitHub)
file: test.yaml
file: test.yml
enabled: true

- group: Tests
type: gh_action
title: Tutorial tests (GitHub)
file: tutorial-tests.yaml
file: tutorial-tests.yml
enabled: true

- group: Tests
type: gh_action
title: Package tests (PyPI)
file: pypi-test.yaml
file: pypi-test.yml
enabled: true

- group: Code Quality
Expand Down Expand Up @@ -60,15 +59,14 @@ cards:
title: Docstring coverage (interrogate)
report: reports/{branch}/coverage-docstring.txt
enabled: true

- group: Build & Release
type: gh_action
title: Publishing (PyPI)
workflow: pypi-publish.yaml
workflow: pypi-publish.yml
enabled: true

- group: Build & Release
type: gh_action
title: Docs build/deployment
workflow: docs.yaml
workflow: docs.yml
enabled: true
10 changes: 0 additions & 10 deletions .copier-answers.lib.yml

This file was deleted.

17 changes: 15 additions & 2 deletions .copier-answers.shared.yml → .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
# WARNING: Do not edit this file manually.
# Any changes will be overwritten by Copier.
_commit: v0.4.0
_src_path: gh:easyscience/templates-shared
_commit: 185e6d8
_src_path: gh:easyscience/templates
app_docs_url: https://easyscience.github.io/peasy-app
app_doi: 10.5281/zenodo.18163581
app_package_name: easypeasy_app
app_python: '3.13'
app_repo_name: peasy-app
lib_docs_url: https://easyscience.github.io/peasy-lib
lib_doi: 10.5281/zenodo.18163581
lib_package_name: easypeasy
lib_python_max: '3.13'
lib_python_min: '3.11'
lib_repo_name: peasy-lib
project_contact_email: support@easypeasy.org
project_copyright_years: 2021-2026
project_extended_description: For performing imaginary calculations based on a theoretical
Expand All @@ -11,3 +22,5 @@ project_name: EasyPeasy
project_repo_name: peasy
project_short_description: Imaginary data analysis
project_shortcut: EP
project_type: both
template_type: lib
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,5 @@ jobs:
# Job 4: Build and publish dashboard (reusable workflow)
run-reusable-workflows:
needs: [docstring-coverage, unit-tests-coverage, integration-tests-coverage] # depend on the previous jobs
uses: ./.github/workflows/dashboard.yaml
uses: ./.github/workflows/dashboard.yml
secrets: inherit
File renamed without changes.
1 change: 0 additions & 1 deletion .github/workflows/docs.yaml → .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ jobs:
# Uses frozen lockfile to ensure reproducible builds.
- name: Set up pixi
uses: ./.github/actions/setup-pixi

# Pre-import the main package to exclude info messages from the docs
# E.g., Matplotlib may print messages to stdout/stderr when first
# imported. This step allows to avoid "Matplotlib is building the font
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,5 @@ jobs:
# Job 2: Build and publish dashboard (reusable workflow)
run-reusable-workflows:
needs: pypi-package-tests # depend on previous job
uses: ./.github/workflows/dashboard.yaml
uses: ./.github/workflows/dashboard.yml
secrets: inherit
13 changes: 6 additions & 7 deletions .github/workflows/quality.yaml → .github/workflows/quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ jobs:
continue-on-error: true
shell: bash
run: pixi run nonpy-format-check

# Check formatting of Jupyter Notebooks in the tutorials folder
- name: Convert tutorial scripts to notebooks and check formatting
id: check_notebooks_formatting
Expand Down Expand Up @@ -110,11 +109,11 @@ jobs:
# Fail job if any check failed
- name: Fail job if any check failed
if: |
steps.check_pyproject.outcome == 'failure' ||
steps.check_code_linting.outcome == 'failure' ||
steps.check_code_formatting.outcome == 'failure' ||
steps.check_docs_formatting.outcome == 'failure' ||
steps.check_others_formatting.outcome == 'failure' ||
steps.check_notebooks_formatting.outcome == 'failure'
steps.check_pyproject.outcome == 'failure'
|| steps.check_code_linting.outcome == 'failure'
|| steps.check_code_formatting.outcome == 'failure'
|| steps.check_docs_formatting.outcome == 'failure'
|| steps.check_others_formatting.outcome == 'failure'
|| steps.check_notebooks_formatting.outcome == 'failure'
shell: bash
run: exit 1
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ jobs:
await github.rest.actions.createWorkflowDispatch({
owner: context.repo.owner,
repo: context.repo.repo,
workflow_id: "test.yaml",
workflow_id: "test.yml",
ref: "develop"
});
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml → .github/workflows/test.ym
Original file line number Diff line number Diff line change
Expand Up @@ -268,5 +268,5 @@ jobs:
# Job 4: Build and publish dashboard (reusable workflow)
run-reusable-workflows:
needs: package-test # depend on previous job
uses: ./.github/workflows/dashboard.yaml
uses: ./.github/workflows/dashboard.yml
secrets: inherit
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ jobs:
await github.rest.actions.createWorkflowDispatch({
owner: context.repo.owner,
repo: context.repo.repo,
workflow_id: "tutorial-tests.yaml",
workflow_id: "tutorial-tests.yml",
ref: "develop"
});
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ jobs:
# Job 2: Build and publish dashboard (reusable workflow)
run-reusable-workflows:
needs: tutorial-tests # depend on previous job
uses: ./.github/workflows/dashboard.yaml
uses: ./.github/workflows/dashboard.yml
secrets: inherit
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ docs/overrides/
docs/site/
docs/docs/assets/

# Python
.pytest_cache/

# MyPy
.mypy_cache
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ calculations based on a theoretical model and refining its parameters
against experimental data.

**EasyPeasy** is available both as a Python library and as a
cross-platform desktop application. Here, we focus on the Python
library. For the graphical user interface (GUI), please see the
corresponding [GUI resources](https://github.com/easyscience/peasy-app).
cross-platform desktop application.

Here, we focus on the Python library. For the graphical user interface
(GUI), please see the corresponding
[GUI resources](https://github.com/easyscience/peasy-app).

## Useful Links

Expand Down
16 changes: 9 additions & 7 deletions docs/docs/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,23 @@ calculations based on a theoretical model and refining its parameters
against experimental data.

**EasyPeasy** is available both as a Python library and as a
cross-platform desktop application. Here, we focus on the Python
library. For the graphical user interface (GUI), please see the
corresponding [GUI resources](https://github.com/easyscience/peasy-app).
cross-platform desktop application.

Here, we focus on the Python library. For the graphical user interface
(GUI), please see the corresponding
[GUI resources](https://easyscience.github.io/peasy-app).

**EasyPeasy** is developed using the
[EasyScience framework](https://easyscience.org).

## License

**EasyPeasy** is released under the
**EasyPeasy** library is released under the
[BSD 3-Clause License](https://raw.githubusercontent.com/easyscience/peasy-lib/master/LICENSE).

## Releases

The latest version of the **EasyPeasy** Python library is
The latest version of the **EasyPeasy** library is
[{{ vars.release_version }}](https://github.com/easyscience/peasy-lib/releases/latest).

For a complete list of new features, bug fixes, and improvements, see
Expand All @@ -34,8 +36,8 @@ the

## Citation

If you use **EasyPeasy** in your work, please cite the specific version
you used.
If you use **EasyPeasy** library in your work, please cite the specific
version you used.

All official releases of the **EasyPeasy** library are archived on
Zenodo, each with a version-specific Digital Object Identifier (DOI).
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ extra:
name: EasyPeasy Main Webpage
- icon: app # File: overrides/.icons/app.svg
link: https://easyscience.github.io/peasy-app
name: EasyDiffraction Application Docs
name: EasyPeasy Application Docs
- icon: fontawesome/brands/github # Name as in Font Awesome
link: https://github.com/easyscience/peasy-lib
name: EasyPeasy Library Source Code on GitHub
Expand Down
Loading
Loading