docs: Add a 'get started' example to the README #130
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eduardo-rodrigues
changed the title
Codecov Report
@@ Coverage Diff @@
## master #130 +/- ##
=======================================
Coverage 62.82% 62.82%
=======================================
Files 2 2
Lines 234 234
Branches 59 59
=======================================
Hits 147 147
Misses 76 76
Partials 11 11
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
eduardo-rodrigues
force-pushed
the
eduardo-readme-1
branch
from
0132d2e to
23a97f8
Compare
|
This seems like a no-brainer in terms of basic documentation. Can we merge it asap :)? |
|
With no further news I will merge later today since really an enhancement to documentation. |
matthewfeickert
changed the title
matthewfeickert
approved these changes
Jun 20, 2022
|
(This is failing for known reasons that will get removed in PR #131 so I'm merging anyway) |
eduardo-rodrigues
added a commit
to jhgoh/pylhe
that referenced
this pull request
Aug 25, 2022
* Add example to README that shows how to open an LHE file and interact with the events.
eduardo-rodrigues
added a commit
that referenced
this pull request
Aug 29, 2022
* take particles up to the eventinfo.nparticles. otherwise put into the optinal field * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * synchronize with the master branch * Add test * Please linting checks * ci: Add semantic PR check GHA workflow (#123) * As https://github.com/zeke/semantic-pull-requests is no longer maintained and is down, use the suggested alternative of https://github.com/amannn/action-semantic-pull-request to check that PR titles follow the Conventional Commits spec. * feat: Add IPython visualisation and switch to graphviz (#118) * Add graphviz>=0.12.0 as a core dependency. * Add graphviz.Digrap graph object as .graph property to LHEFile. - Add support for IPython visualization. * Add test for LHEEvent_graph. * refactor: Use absolute imports over explicit relative imports (#124) * Change all explicit relative imports to absolute imports. - Provides clearer more explicit imports for new developers. * Add absolufy-imports to pre-commit hooks * feat: Use tbump over bump2version (#125) * Add tbump to 'develop' extra and remove bump2version. * Add tbump.toml to configure tbump. - Allow for valid versions to follow SemVer and also support release candidates: <major>.<minor>.<patch>rc<candidate> * Remove .bumpversion.cfg. * Bump version: 0.2.1 → 0.3.0 * docs: Update dev team affiliations (#126) * Lukas Heinrich is a professor at Technical University of Munich as of March 2022. * Matthew Feickert is a postdoc at University of Wisconsin-Madison as of June 2022. * docs: Add Eduardo Rodrigues to dev team (#127) * Add Eduardo Rodrigues to development team listing. - Update Zenodo citation metadata, recommended citation, and setup.cfg. * chore: [pre-commit.ci] pre-commit autoupdate (#129) * Update pre-commit hooks: - github.com/asottile/pyupgrade: v2.32.0 → v2.32.1 * docs: Add a 'get started' example to the README (#130) * Add example to README that shows how to open an LHE file and interact with the events. * chore: [pre-commit.ci] pre-commit autoupdate (#133) * Update pre-commit hooks: - github.com/pre-commit/pre-commit-hooks: v4.2.0 → v4.3.0 - github.com/asottile/pyupgrade: v2.31.1 → v2.34.0 - github.com/psf/black: 22.3.0 → 22.6.0 * take particles up to the eventinfo.nparticles. otherwise put into the optinal field * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * synchronize with the master branch * Cover lines added/changed Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: eduardo-rodrigues <[email protected]> Co-authored-by: Matthew Feickert <[email protected]>
APN-Pucky
added a commit
to APN-Pucky/pylhe
that referenced
this pull request
Feb 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to task #30 on package documentation.