Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

Revision d378a5fbb6db29f7153fad784f322f2f48e9d7c2 authored by Matt Garthwaite on 08 September 2020, 04:23:27 UTC, committed by GitHub on 08 September 2020, 04:23:27 UTC
Merge pull request #295 from GeoscienceAustralia/develop
Release 0.5.0
2 parent s f77ad6e + df7cb1e
  • Files
  • Changes
  • b6c6ee3
  • /
  • utils
  • /
  • developer_hints.txt
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • revision
  • directory
  • content
revision badge
swh:1:rev:d378a5fbb6db29f7153fad784f322f2f48e9d7c2
directory badge
swh:1:dir:0cc04becdf6e0f433dcea1b655f5995e0f0d64ba
content badge
swh:1:cnt:524b2c353794a9a356868b4aa8b133bd0da58c39

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • revision
  • directory
  • content
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
developer_hints.txt
# publish package to PyPI

follow the steps at: https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56

Summary:

1) create new 'release' in Github. this will tag a commit hash.
2) copy link to tar.gz Source Code from github release, add to download_url in setup.py
3) update version number in setup.py (to match the Github release)
4) `python3 setup.py sdist bdist_wheel` - prepare package
5) `python3 -m twine upload --repository testpypi dist/*` - test upload that does not affect real PyPI
5) `python3 -m twine upload dist/*` - upload package to PyPI

check out here also: https://packaging.python.org/tutorials/packaging-projects/

---------------------------------------------
# Clone Github repo
cd ~
git clone git@github.com:GeoscienceAustralia/PyRate.git
or
git clone https://github.com/GeoscienceAustralia/PyRate.git 

# build PyRate package
cd ~/PyRate
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -r requirements-test.txt
python3 setup.py install

# Run workflow, one step at a time
pyrate conv2tif -f input_parameters.conf
pyrate prepifg -f input_parameters.conf
pyrate correct -f input_parameters.conf
pyrate timeseries -f input_parameters.conf
pyrate stack -f input_parameters.conf
pyrate merge -f input_parameters.conf

# or run all workflow steps in order
pyrate workflow -f input_parameters.conf

# alternatively run commands via python, e.g.
python3 pyrate/main.py workflow -f input_parameters.conf

---------------------------------------
# Build Sphinx docs
pip install -r requirements-dev.txt
cd /PyRate/docs && make html

---------------------------------------
# Run unit tests, avoiding those marked as "slow"
pip install -r requirements-test.txt
cd /PyRate
# file permission change required for a test:
chmod 444 tests/test_data/small_test/tif/geo_070709-070813_unw.tif
pytest tests/ -m "not slow"

---------------------------------------
NCI Gadi supercomputer

ssh <username>@gadi.nci.org.au

rm -rf ~/PyRate
rm -rf ~/PyRateVenv

git clone git@github.com:GeoscienceAustralia/PyRate.git
source PyRate/scripts/nci_load_modules.sh
python3 -m venv ~/PyRateVenv
source ~/PyRateVenv/bin/activate
cd ~/PyRate
pip install -r requirements-dev.txt
pip install -r requirements-test.txt
pip install -r requirements.txt

python3 setup.py install

# run with debug messages
pyrate -v DEBUG workflow -f input_parameters.conf

# run using MPI
mpirun -n 6 pyrate workflow -f input_parameters.conf
The diff you're trying to view is too large. Only the first 1000 changed files have been loaded.
Showing with 0 additions and 0 deletions (0 / 0 diffs computed)
swh spinner

Computing file changes ...

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API