Skip to content

Readme updates#36

Merged
matthewturk merged 13 commits intomasterfrom
Readme_Updates
Sep 2, 2022
Merged

Readme updates#36
matthewturk merged 13 commits intomasterfrom
Readme_Updates

Conversation

@samwalkow
Copy link
Member

This is a pull request that contains changes to the readme and adds two new markdown files with examples that include loading, subsetting, and plotting data. Those are in the examples folder.

@chrishavlin
Copy link
Collaborator

Oh! forgot to mention: I like the .md examples. It's nice to have those plain-text examples. One tricky thing is that as development happens, it's easy for those sorts of files to become out of date (e.g., say we update the schema, we have to remember to go update all those examples). But once we have a full documentation, we can dynamically embed examples more easily -- so you could move the json bits into their own json files and then we would embed those in the docs. That allows us to write tests that actually run all the example jsons to make sure they continue working.

samwalkow and others added 3 commits September 2, 2022 15:13
Co-authored-by: Chris Havlin <chris.havlin@gmail.com>
Co-authored-by: Chris Havlin <chris.havlin@gmail.com>
@chrishavlin
Copy link
Collaborator

@samwalkow this looks good to me, did you want to add anything else here? shall I merge?

Co-authored-by: Matthew Turk <matthewturk@gmail.com>

After running that line of code in the command line, image files of a projection plot or other visauls are returned.

Documentation is coming soon to: https://analysis-schema.readthedocs.io.
Copy link
Member

Choose a reason for hiding this comment

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

Will it be up by the time the package is published?


## Dependencies

Currently, the Analysis Schema is built from [yt](https://github.com/yt-project/yt), a python library for analyzing and visauliation volumetric data. It also uses [pydantic](https://github.com/pydantic/pydantic) to create the schema and validate workflow input.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Currently, the Analysis Schema is built from [yt](https://github.com/yt-project/yt), a python library for analyzing and visauliation volumetric data. It also uses [pydantic](https://github.com/pydantic/pydantic) to create the schema and validate workflow input.
Currently, the Analysis Schema is built for [yt](https://github.com/yt-project/yt), a python library for analyzing and visauliation volumetric data. It also uses [pydantic](https://github.com/pydantic/pydantic) to create the schema and validate workflow input.


## License

* Free software: MIT license
Copy link
Member

Choose a reason for hiding this comment

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

Aren't we on BSD 3-Clause?

@matthewturk matthewturk merged commit 2fd9408 into master Sep 2, 2022
@samwalkow samwalkow deleted the Readme_Updates branch September 2, 2022 20:37
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.

update the examples update the top-level readme documentation improvements

3 participants