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

File formats to RTD #102

Merged
merged 3 commits into from
Oct 15, 2024
Merged

File formats to RTD #102

merged 3 commits into from
Oct 15, 2024

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Oct 15, 2024

@dweindl dweindl requested a review from dilpath October 15, 2024 12:48
@dweindl dweindl mentioned this pull request Oct 15, 2024
4 tasks
Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

Nice, thanks a lot. Looks good for now. I will think about how to present the YAML structure better -- I might also switch to using mkstd for schema/validation too. Fine to merge now 👍

@dweindl
Copy link
Member Author

dweindl commented Oct 15, 2024

present the YAML structure better

Yeah, that doesn't look nice at the moment. Can be addressed in another iteration. I wanted to keep the changes to a minimum, because the diff is unpleasant.

I think just replacing the brackets by an # optional comment will make the yaml listings look much better. also the data types could be listed as comments, and some example values could be filled in.

@dilpath
Copy link
Member

dilpath commented Oct 15, 2024

I think just replacing the brackets by an # optional comment will make the yaml listings look much better. also the data types could be listed as comments, and some example values could be filled in.

Thanks, looks better like this. I will anyway have to comb over the docs again, since a few small things have changed. I'll merge this now, thanks!

@dilpath dilpath merged commit aae2118 into develop Oct 15, 2024
3 checks passed
@dweindl dweindl deleted the rtd_fileformat branch October 15, 2024 13:30
dilpath added a commit that referenced this pull request Nov 18, 2024
* make model hashes nicer; add model hash to model method

* :class:`ModelHash`

* support user-supplied models with no specified subspace

* Skip virtual models in `models_to_yaml_list` (#66)

* Action updates via dependabot (#92)

* GHA: Add PyPI deployment workflow (#91)

Related to #89

* Fix minimum Python requirement (#97)

petab requires python>=3.10

* Doc: Fix heading levels in example (#96)



Fixes the sphinx TOC and a typo.

* Get rid of petab DeprecationWarnings (#93)

Closes #90

* README.md: PyPI badge

* Add some docs; ensure similar PEtab problems in distance calculation (#67)

* File formats to RTD (#102)

* Move test suite description to RTD (#101)

Related to #95.

* User-calibrated models (#87)

* compute safe petab hash digest size; support custom digest size; refactor `CandidateSpace` excluded hashes; add `end_iteration`; rename `candidates`->`start_iteration`; change workflow as described in changelog

* `ModelHash.__eq__`: support comparisons with `str` and partial hashes

* repro: narrow bounds in test cases 1-8

* Add logo draft (#103)

* add to RTD, closes #88

* Set up `setuptools_scm` (#100)

Set up `setuptools_scm` and move most package configuration to `pyproject.toml`.

Move git-based package URLs out of `pyproject.toml` (otherwise, PyPI upload will fail).


Co-authored-by: Dilan Pathirana <[email protected]>

* Doc: Update RTD landing page (#105)

* Doc: Update RTD landing page

Add a bit of content. #95.

* Apply suggestions from code review

Co-authored-by: Dilan Pathirana <[email protected]>

* Formatting, spelling, links

---------

Co-authored-by: Dilan Pathirana <[email protected]>

* Switch from black/isort/... to ruff (#99)

Replace black/isort/... by ruff. Run `pre-commit run --all-files`.

Some additional rules should be enabled, but that will require additional effort.


---------

Co-authored-by: Dilan Pathirana <[email protected]>

* Update file format spec (#106)

* add example to model space, to clarify compressed format

Co-authored-by: Daniel Weindl <[email protected]>

* Doc: fix list formatting (#107)

* test case 0009: update predecessor model

* Visualization methods (#36)

* closes #104

---------

Co-authored-by: Daniel Weindl <[email protected]>
Co-authored-by: Daniel Weindl <[email protected]>

* Support SSR as criterion (#108)

* closes #44

* changelog

---------

Co-authored-by: Dilan Pathirana <[email protected]>
Co-authored-by: Daniel Weindl <[email protected]>
Co-authored-by: Daniel Weindl <[email protected]>
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.

2 participants