The source project of this merge request has been removed.
Minor fixes for docs and lfs
This merge request fixes issues with regards to the tracking of txt files in lfs due to 74ebfc8a .
All requirements.txt files are now excluded from lfs tracking.
Further improvements:
- Add missing requirements to build documentations from source
- Add svg version of the logo such that it is displayed in html documentation
- Remove leading spaces in filenames of plots which cause issue with some file systems
Current situation
Click to view terminal log
simon@finneganfox /tmp/now % git clone https://git.ligo.org/lscsoft/pyring.git
Cloning into 'pyring'...
remote: Enumerating objects: 4790, done.
remote: Counting objects: 100% (779/779), done.
remote: Compressing objects: 100% (397/397), done.
remote: Total 4790 (delta 535), reused 537 (delta 369), pack-reused 4011
Receiving objects: 100% (4790/4790), 55.24 MiB | 2.75 MiB/s, done.
Resolving deltas: 100% (3235/3235), done.
simon@finneganfox /tmp/now % cd pyring
simon@finneganfox /tmp/now/pyring (git)-[master] % git lfs pull
simon@finneganfox /tmp/now/pyring (git)-[master] % git status
On branch master
Your branch is up to date with 'origin/master'.
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: docs/requirements.txt
modified: pyRing/data/NR_data/ParSpec_coefficients.txt
modified: pyRing/data/NR_data/ParSpec_coefficients_high_spin.txt
modified: pyRing/data/NR_data/berti_qnm_fits.txt
modified: pyRing/data/PSDs/ASD_LIGO-P1200087-v18-AdV_DESIGN.txt
modified: pyRing/data/PSDs/ASD_LIGO-P1200087-v18-aLIGO_DESIGN.txt
modified: pyRing/data/Real_data/GW150914/GW150914_LAL_IMRPhenomP_O1_GWOSC_Mf_af_samples.txt
modified: pyRing/data/Real_data/GW150914/H-H1_GWOSC_4KHZ_R1-1126259447-32.txt
modified: pyRing/data/Real_data/GW150914/L-L1_GWOSC_4KHZ_R1-1126259447-32.txt
modified: pyRing/data/Real_data/GW170814/H-H1_GWOSC_4KHZ_R1-1186741846-32.txt
modified: pyRing/data/Real_data/GW170814/L-L1_GWOSC_4KHZ_R1-1186741846-32.txt
modified: pyRing/data/Real_data/GW170814/V-V1_GWOSC_4KHZ_R1-1186741846-32.txt
modified: scripts/Analysis_utils/ACFs_examples/ACF_H1_1126257415_4096_4.0_1024.0.txt
modified: scripts/Analysis_utils/ACFs_examples/ACF_H1_1126257415_4096_4.0_16384.0.txt
modified: scripts/Analysis_utils/ACFs_examples/ACF_H1_1126257415_4096_4.0_2048.0.txt
modified: scripts/Analysis_utils/ACFs_examples/ACF_H1_1126257415_4096_4.0_4096.0.txt
modified: scripts/Analysis_utils/ACFs_examples/ACF_H1_1126257415_4096_4.0_8192.0.txt
Previous situation
Click to view terminal log
simon@finneganfox /tmp/old % git clone https://git.ligo.org/lscsoft/pyring.git
Cloning into 'pyring'...
remote: Enumerating objects: 4790, done.
remote: Counting objects: 100% (779/779), done.
remote: Compressing objects: 100% (397/397), done.
remote: Total 4790 (delta 535), reused 537 (delta 369), pack-reused 4011
Receiving objects: 100% (4790/4790), 55.24 MiB | 3.26 MiB/s, done.
Resolving deltas: 100% (3235/3235), done.
simon@finneganfox /tmp/old % cd pyring
simon@finneganfox /tmp/old/pyring (git)-[master] % git reset --hard HEAD~3
HEAD is now at b03adf5 Merge branch 'master' into add_version
simon@finneganfox /tmp/old/pyring (git)-[master] % git lfs pull
simon@finneganfox /tmp/old/pyring (git)-[master] % git status
On branch master
Your branch is behind 'origin/master' by 3 commits, and can be fast-forwarded.
(use "git pull" to update your local branch)
nothing to commit, working tree clean
Fixed situation
Click to view terminal log
simon@finneganfox /tmp/new % git clone git@git.ligo.org:simon.maenaut/pyring-temporary.git
Cloning into 'pyring-temporary'...
remote: Enumerating objects: 4809, done.
remote: Counting objects: 100% (798/798), done.
remote: Compressing objects: 100% (250/250), done.
remote: Total 4809 (delta 547), reused 775 (delta 535), pack-reused 4011
Receiving objects: 100% (4809/4809), 55.34 MiB | 2.95 MiB/s, done.
Resolving deltas: 100% (3247/3247), done.
simon@finneganfox /tmp/new % cd pyring-temporary
simon@finneganfox /tmp/new/pyring-temporary (git)-[master] % git switch minor-fixes-for-docs-and-lfs
branch 'minor-fixes-for-docs-and-lfs' set up to track 'origin/minor-fixes-for-docs-and-lfs'.
Switched to a new branch 'minor-fixes-for-docs-and-lfs'
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % git lfs pull
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % git status
On branch minor-fixes-for-docs-and-lfs
Your branch is up to date with 'origin/minor-fixes-for-docs-and-lfs'.
nothing to commit, working tree clean
Additional logs for building the html documentation
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % python -m venv ../pyring-env
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % source ../pyring-env/bin/activate
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % pip install --upgrade pip
[REDACTED]
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % pip install -r requirements.txt
[REDACTED]
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % python setup.py install
[REDACTED]
simon@finneganfox /tmp/new/pyring-temporary (git)-[minor-fixes-for-docs-and-lfs] % cd docs
simon@finneganfox /tmp/new/pyring-temporary/docs (git)-[minor-fixes-for-docs-and-lfs] % pip install -r requirements.txt
[REDACTED]
simon@finneganfox /tmp/new/pyring-temporary/docs (git)-[minor-fixes-for-docs-and-lfs] % make html
[REDACTED]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] waveforms
generating indices... genindex py-modindex done
highlighting module code... [100%] pyRing.waveform
writing additional pages... search done
copying images... [100%] pyRing_docs_image.svg
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 115 warnings.
The HTML pages are in _build/html.