IAP GITLAB
Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
corsika
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Pranav Sampathkumar
corsika
Commits
2577d686
Commit
2577d686
authored
4 years ago
by
Remy Prechelt
Committed by
Ralf Ulrich
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Added discussion of the Makefile targets to README.
parent
56dc2f65
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Python/README.md
+25
-1
25 additions, 1 deletion
Python/README.md
with
25 additions
and
1 deletion
Python/README.md
+
25
−
1
View file @
2577d686
...
...
@@ -19,7 +19,7 @@ You can verify that the installation was successful by trying to import `corsika
python -c 'import corsika'
# Running the Tests
#
# Running the Tests
If you wish to develop new features in
`corsika`
, you will also need to install
some additional dependencies so you can run our unit tests. These can be
...
...
@@ -30,3 +30,27 @@ installed with
Once that is completed, you can run the unit tests directory from the
`corsika`
directory
python -m pytest tests
## Development Guide
`corsika`
is a type Python package with type-checking using
[
Mypy
](
mypy-lang.org
)
and all code is formatted with the
[
Black
](
https://black.readthedocs.io/en/stable/
)
formatter.
All code must pass these checks, as well as several others, before it can be
merged into CORSIKA. A
`Makefile`
is provided to simplify running these in
tasks.
make mypy # this will run the mypy type checker
make isort # this will automatically sort `import` statements
make black # this will automatically format your code
make flake # this checks that all code passes our linting rules
make tests # this runs our test suite
Lastly, we provide an
`all`
target that runs
*all*
of the above in the sequence shown above:
make all # run all of the above tests
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment