Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pycalibration
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Model registry
Analyze
Contributor 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
calibration
pycalibration
Commits
b98fed75
Commit
b98fed75
authored
4 years ago
by
Robert Rosca
Browse files
Options
Downloads
Patches
Plain Diff
Add todos, adjust headings
parent
d6b83d8b
No related branches found
No related tags found
2 merge requests
!433
Fix/pre commit whitespace
,
!417
Feat/pre commit checks
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+41
-2
41 additions, 2 deletions
README.rst
with
41 additions
and
2 deletions
README.rst
+
41
−
2
View file @
b98fed75
...
...
@@ -73,11 +73,48 @@ venv) activate the virtual environment first, and then run:
python3 -m pip install ipykernel # If not using a venv add `--user` flag
python3 -m ipykernel install --user --name pcalibration --display-name "pcalibration" # If not using a venv pick different name
This can be useful for Jupyter notebook tools as "max-jhub.desy.de".
This can be useful for Jupyter notebook tools as https://max-jhub.desy.de/hub/login
Contributing
************
Code Standards
==============
... something?
TODO: How should we handle where what information goes? Right now a decent
amount of stuff is in the wiki, but I think it's a bit nicer to have some of the
information in the readme as it'll be there and visible when you clone the repo.
Basics
======
The installation instructions above assume that you have set up SSH keys for use
with GitLab to allow for passwordless clones from GitLab, this way it's possible
to run ``pip install git+ssh...`` commands and install packages directly from
GitLab.
To do this check the settings page here: https://git.xfel.eu/gitlab/profile/keys
Pre-Commit Hooks
================
This repository uses pre-commit hooks to ensure that a number of checks have
been made before code is committed and pushed to the...
TODO:
1. List of checks
2. Mention how the CI only runs on diffs between PR branch and target branch
3. Include runnable script to have same behaviour as on gitlab
4. Mention having to rebase for diffs to be correct if merge target changes
Python Scripted Calibration
===========================
***************************
**Do not run this on the Maxwell gateway**. Rather, ``salloc`` a node for
yourself first:
...
...
@@ -95,6 +132,8 @@ not using a venv).
If running headless (i.e. without X forwarding), be sure to set
``MPLBACKEND=Agg``, via:
.. code::
export MPLBACKEND=Agg
Then start an ``ipcluster``. If you followed the steps above this can be done
...
...
This diff is collapsed.
Click to expand it.
Robert Rosca
@roscar
mentioned in commit
e49dcbcf
·
4 years ago
mentioned in commit
e49dcbcf
mentioned in commit e49dcbcf1a5ec882c994fc35228951f82e9e5942
Toggle commit list
Robert Rosca
@roscar
mentioned in commit
385d6aab
·
4 years ago
mentioned in commit
385d6aab
mentioned in commit 385d6aab246bf6e7ed04575a5c42a4265b1cd788
Toggle commit list
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