Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
pygwinc
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
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
Lee McCuller
pygwinc
Commits
314944a8
Commit
314944a8
authored
4 years ago
by
Jameson Rollins
Browse files
Options
Downloads
Patches
Plain Diff
improvements/fixes to the README
parent
ec5cc9ba
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
README.md
+27
-19
27 additions, 19 deletions
README.md
with
27 additions
and
19 deletions
README.md
+
27
−
19
View file @
314944a8
...
...
@@ -50,16 +50,37 @@ figures of merit for gravitational wave detector budgets. See the
`pygwinc`
provides a command line interface that can be used to
calculate and plot the various canonical IFO noise budgets described
above
, as well as custom noise budgets (see below)
:
above:
```
shell
$
python3
-m
gwinc aLIGO
```
Budget plots save/plot hdf5 trace data, and dump budget IFO parameters:
Or
[
Custom budgets
](
#budget-interface
)
may also be processed by providing
the path to the budget module/package:
```
shell
$
python3
-m
gwinc path/to/mybudget
```
Budget plots can be saved in various formats (.png, .svg, .pdf):
```
shell
$
python3
-m
gwinc
--save
aLIGO.png aLIGO
```
Or trace data can be saved to an
[
HDF5
](
https://en.wikipedia.org/wiki/Hierarchical_Data_Format
)
file:
```
shell
$
python3
-m
gwinc
--save
aLIGO.hdf5 aLIGO
```
Trace HDF5 files can also be plotted directly:
```
shell
$
python3
-m
gwinc aLIGO.hdf5
```
You can play with IFO parameters and see the effects on the budget by
dumping the pre-defined parameters to a
[
YAML-formatted parameter
file
](
#yaml-parameter-files
)
, editing the parameter file, and
re-calculating the noise budget:
IFO parameters can be manipulated from the command line with the
`--ifo`
option:
```
shell
$
python3
-m
gwinc aLIGO
--ifo
Optics.SRM.Tunephase
=
3.14
```
You can also dump the IFO parameters to a
[
YAML-formatted parameter
file
](
#yaml-parameter-files
)
:
```
shell
$
python3
-m
gwinc
--yaml
aLIGO
>
my_aLIGO.yaml
$
edit my_aLIGO.yaml
...
...
@@ -68,22 +89,9 @@ $ python3 -m gwinc -d my_aLIGO.yaml aLIGO
Materials.Coating.Philown 5e-05 3e-05
$
python3
-m
gwinc my_aLIGO.yaml
```
You can also use the
`--ifo`
option to change parameters from the
command line:
```
shell
$
python3
-m
gwinc aLIGO
--ifo
Optics.SRM.Tunephase
=
3.14
```
Stand-alone YAML files assume the nominal
[
'aLIGO' budget
description
](
gwinc/ifo/aLIGO
)
.
[
Custom budgets
](
#budget-interface
)
may also be processed by providing
the path to the budget module/package:
```
shell
$
python3
-m
gwinc path/to/mybudget
```
The command line interface also includes an "interactive" mode which
provides an
[
IPython
](
https://ipython.org/
)
shell for interacting with
a processed budget:
...
...
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