Skip to content

Commit

Permalink
update howto_release
Browse files Browse the repository at this point in the history
  • Loading branch information
rjleveque committed Apr 1, 2024
1 parent 745b2c4 commit 06514eb
Show file tree
Hide file tree
Showing 850 changed files with 119 additions and 242 deletions.
53 changes: 16 additions & 37 deletions _sources/howto_release.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,13 @@ make sure everything looks correct.
Version numbers
---------------

Change the version number in `clawpack/clawpack/__init__.py`.
Initially set it to e.g. v5.4.1rc-alpha, then to the final release number.
Change the version number in the following files to the new version number:

- `clawpack/clawpack/__init__.py`
- `clawpack/setup.py`
- `clawpack/pyproject.toml`


The version number is also set in `clawpack/setup.py` and should be changed
there to be consistent with `clawpack/clawpack/__init__.py`

Release candidates
------------------
Expand Down Expand Up @@ -125,48 +127,25 @@ the current master branch of each repository.

Pypi
----
To release on the pypi server (for installation via pip) we have to do a bit
of trickery. We can't just follow the directions at https://packaging.python.org/tutorials/packaging-projects/
because we have a very non-Pythonic directory structure; in particular,
the subdirectories `clawpack/x/` do not have an `__init__.py`.

Here's what to do, starting with a clean clone in some directory
referred to below as `$TEMP` (replace `5.x.x` by the new version number)::
To release on the pypi server (for installation via pip) we
simply build from a clean clone and upload::

cd $TEMP
git clone https://github.com/clawpack/clawpack.git
cd clawpack # should now be in $TEMP/clawpack
source pull_all.sh
git submodule update --init --recursive
git-archive-all --prefix clawpack-5.x.x/ clawpack-5.x.x.tar

mv clawpack-5.x.x.tar ..
cd ..
tar -xf clawpack-5.x.x.tar # creates $TEMP/clawpack-5.x.x

cd clawpack
python3 setup.py sdist # creates $TEMP/clawpack/dist/clawpack-5.x.x.tar.gz
cd dist # should be in $TEMP/clawpack/dist
tar -xzf clawpack-5.x.x.tar.gz

cp clawpack-5.x.x/PKG-INFO ../../clawpack-5.x.x
rm -rf clawpack-5.x.x
git submodule init
git submodule update
python -m build

cd ../.. # should be in $TEMP
rm clawpack-5.x.x.tar
tar -cf clawpack-5.x.x.tar clawpack-5.x.x
gzip clawpack-5.x.x.tar
mv clawpack-5.x.x.tar.gz clawpack/dist
To upload to Pypi you need an account there and you must be listed as a
maintainer of Clawpack. Then you can update using
`twine <https://pypi.org/project/twine/>`__.

Upload to the testpypi server for testing
(you will need to have created an account there)::
You can first upload to the testpypi server for testing::

cd clawpack # should be in $TEMP/clawpack
twine upload --repository-url https://test.pypi.org/legacy/ dist/*

credentials: [[test pypi]]

Click the link and check that it looks okay. You can also test via::
Click the link and check that it looks okay. You can also test installation via::

pip3 uninstall clawpack
pip3 install —no-cache—dir —index-url https://test.pypi.org/simple/ clawpack
Expand Down
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 261a43d620e8cb9dbc7e51304364f141
config: f3e3f588d35153da444ad05e85efd4eb
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified dev/.doctrees/ClawPlotAxes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotData.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotFigure.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotItem.doctree
Binary file not shown.
Binary file modified dev/.doctrees/about.doctree
Binary file not shown.
Binary file modified dev/.doctrees/adjoint.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amr_algorithm.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw_doxygen.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw_flowcharts.doctree
Binary file not shown.
Binary file modified dev/.doctrees/application_documentation.doctree
Binary file not shown.
Binary file modified dev/.doctrees/apps.doctree
Binary file not shown.
Binary file modified dev/.doctrees/aws.doctree
Binary file not shown.
Binary file modified dev/.doctrees/b4run.doctree
Binary file not shown.
Binary file modified dev/.doctrees/b4step_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/biblio.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bouss1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bouss2d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/changes_to_master.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw43to46.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw46to50.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw4x.doctree
Binary file not shown.
Binary file modified dev/.doctrees/clawpack5.doctree
Binary file not shown.
Binary file modified dev/.doctrees/clawpack_components.doctree
Binary file not shown.
Binary file modified dev/.doctrees/community.doctree
Binary file not shown.
Binary file modified dev/.doctrees/contents.doctree
Binary file not shown.
Binary file modified dev/.doctrees/contribute_apps.doctree
Binary file not shown.
Binary file modified dev/.doctrees/current_data.doctree
Binary file not shown.
Binary file modified dev/.doctrees/developers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/docker_image.doctree
Binary file not shown.
Binary file modified dev/.doctrees/dtopotools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/environment.pickle
Binary file not shown.
Binary file modified dev/.doctrees/f77_vs_f90.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgmax.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgmax_tools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgout.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgout_tools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run_fortran.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run_pyclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/flagregions.doctree
Binary file not shown.
Binary file modified dev/.doctrees/force_dry.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fortran.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fortran_compilers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fvmbook.doctree
Binary file not shown.
Binary file modified dev/.doctrees/galleries.doctree
Binary file not shown.
Binary file modified dev/.doctrees/gauges.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw_started.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw_util_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geohints.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoplot.doctree
Binary file not shown.
Binary file modified dev/.doctrees/git_versions.doctree
Binary file not shown.
Binary file modified dev/.doctrees/googleearth_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/gpu.doctree
Binary file not shown.
Binary file modified dev/.doctrees/grid_registration.doctree
Binary file not shown.
Binary file modified dev/.doctrees/howto_doc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/howto_release.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing_fortcodes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing_pip.doctree
Binary file not shown.
Binary file modified dev/.doctrees/kmltools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/lagrangian_gauges.doctree
Binary file not shown.
Binary file modified dev/.doctrees/license.doctree
Binary file not shown.
Binary file modified dev/.doctrees/makefiles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/makefiles_library.doctree
Binary file not shown.
Binary file modified dev/.doctrees/manning.doctree
Binary file not shown.
Binary file modified dev/.doctrees/mapc2p.doctree
Binary file not shown.
Binary file modified dev/.doctrees/marching_front.doctree
Binary file not shown.
Binary file modified dev/.doctrees/matlab_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/nearshore_interp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/netcdf.doctree
Binary file not shown.
Binary file modified dev/.doctrees/newapp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/okada.doctree
Binary file not shown.
Binary file modified dev/.doctrees/openmp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/output_styles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/packages.doctree
Binary file not shown.
Binary file modified dev/.doctrees/photos.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotexamples.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_faq.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_python.doctree
Binary file not shown.
Binary file modified dev/.doctrees/prereqs.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/about.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/basics.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/classes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/cloud.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/controller.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/evolve/limiters.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/examples.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/geometry.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/going_further.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/index.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/io.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/output.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/parallel.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/problem.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/rp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/solution.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/solvers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/started.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/state.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/troubleshooting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/tutorial.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/util.doctree
Binary file not shown.
Binary file modified dev/.doctrees/python.doctree
Binary file not shown.
Binary file modified dev/.doctrees/python_path.doctree
Binary file not shown.
Binary file modified dev/.doctrees/qinit_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/quick_surge.doctree
Binary file not shown.
Binary file modified dev/.doctrees/quick_tsunami.doctree
Binary file not shown.
Binary file modified dev/.doctrees/refinement.doctree
Binary file not shown.
Binary file modified dev/.doctrees/regression.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_0_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_10_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_1_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_3_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_3_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_4_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_4_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_5_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_6_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_6_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_7_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_7_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/releases.doctree
Binary file not shown.
Binary file modified dev/.doctrees/restart.doctree
Binary file not shown.
Binary file modified dev/.doctrees/riemann.doctree
Binary file not shown.
Binary file modified dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ruled_rectangles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sealevel.doctree
Binary file not shown.
Binary file modified dev/.doctrees/set_eta_init.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setaux_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setenv.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setplot.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_amrclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_amrclaw_sample.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_sample.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sharing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sphere_source.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sphinxdoc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/src1d_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/src_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/storm_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/surgedata.doctree
Binary file not shown.
Binary file modified dev/.doctrees/testing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/timing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topo.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topotools.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topotools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/trouble.doctree
Binary file not shown.
Binary file modified dev/.doctrees/tsunamidata.doctree
Binary file not shown.
Binary file modified dev/.doctrees/user_routines.doctree
Binary file not shown.
Binary file modified dev/.doctrees/visit_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/vm.doctree
Binary file not shown.
Binary file modified dev/.doctrees/wp_algorithms.doctree
Binary file not shown.
53 changes: 16 additions & 37 deletions dev/_sources/howto_release.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,13 @@ make sure everything looks correct.
Version numbers
---------------

Change the version number in `clawpack/clawpack/__init__.py`.
Initially set it to e.g. v5.4.1rc-alpha, then to the final release number.
Change the version number in the following files to the new version number:

- `clawpack/clawpack/__init__.py`
- `clawpack/setup.py`
- `clawpack/pyproject.toml`


The version number is also set in `clawpack/setup.py` and should be changed
there to be consistent with `clawpack/clawpack/__init__.py`

Release candidates
------------------
Expand Down Expand Up @@ -125,48 +127,25 @@ the current master branch of each repository.

Pypi
----
To release on the pypi server (for installation via pip) we have to do a bit
of trickery. We can't just follow the directions at https://packaging.python.org/tutorials/packaging-projects/
because we have a very non-Pythonic directory structure; in particular,
the subdirectories `clawpack/x/` do not have an `__init__.py`.

Here's what to do, starting with a clean clone in some directory
referred to below as `$TEMP` (replace `5.x.x` by the new version number)::
To release on the pypi server (for installation via pip) we
simply build from a clean clone and upload::

cd $TEMP
git clone https://github.com/clawpack/clawpack.git
cd clawpack # should now be in $TEMP/clawpack
source pull_all.sh
git submodule update --init --recursive
git-archive-all --prefix clawpack-5.x.x/ clawpack-5.x.x.tar

mv clawpack-5.x.x.tar ..
cd ..
tar -xf clawpack-5.x.x.tar # creates $TEMP/clawpack-5.x.x

cd clawpack
python3 setup.py sdist # creates $TEMP/clawpack/dist/clawpack-5.x.x.tar.gz
cd dist # should be in $TEMP/clawpack/dist
tar -xzf clawpack-5.x.x.tar.gz

cp clawpack-5.x.x/PKG-INFO ../../clawpack-5.x.x
rm -rf clawpack-5.x.x
git submodule init
git submodule update
python -m build

cd ../.. # should be in $TEMP
rm clawpack-5.x.x.tar
tar -cf clawpack-5.x.x.tar clawpack-5.x.x
gzip clawpack-5.x.x.tar
mv clawpack-5.x.x.tar.gz clawpack/dist
To upload to Pypi you need an account there and you must be listed as a
maintainer of Clawpack. Then you can update using
`twine <https://pypi.org/project/twine/>`__.

Upload to the testpypi server for testing
(you will need to have created an account there)::
You can first upload to the testpypi server for testing::

cd clawpack # should be in $TEMP/clawpack
twine upload --repository-url https://test.pypi.org/legacy/ dist/*

credentials: [[test pypi]]

Click the link and check that it looks okay. You can also test via::
Click the link and check that it looks okay. You can also test installation via::

pip3 uninstall clawpack
pip3 install —no-cache—dir —index-url https://test.pypi.org/simple/ clawpack
Expand Down
62 changes: 21 additions & 41 deletions dev/howto_release.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,14 @@ <h2>Preparation<a class="headerlink" href="#preparation" title="Permalink to thi
</section>
<section id="version-numbers">
<h2>Version numbers<a class="headerlink" href="#version-numbers" title="Permalink to this heading"></a></h2>
<p>Change the version number in <cite>clawpack/clawpack/__init__.py</cite>.
Initially set it to e.g. v5.4.1rc-alpha, then to the final release number.</p>
<p>The version number is also set in <cite>clawpack/setup.py</cite> and should be changed
there to be consistent with <cite>clawpack/clawpack/__init__.py</cite></p>
<p>Change the version number in the following files to the new version number:</p>
<blockquote>
<div><ul class="simple">
<li><p><cite>clawpack/clawpack/__init__.py</cite></p></li>
<li><p><cite>clawpack/setup.py</cite></p></li>
<li><p><cite>clawpack/pyproject.toml</cite></p></li>
</ul>
</div></blockquote>
</section>
<section id="release-candidates">
<h2>Release candidates<a class="headerlink" href="#release-candidates" title="Permalink to this heading"></a></h2>
Expand Down Expand Up @@ -190,47 +194,23 @@ <h2>Final release<a class="headerlink" href="#final-release" title="Permalink to
</section>
<section id="pypi">
<h2>Pypi<a class="headerlink" href="#pypi" title="Permalink to this heading"></a></h2>
<p>To release on the pypi server (for installation via pip) we have to do a bit
of trickery. We can’t just follow the directions at <a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/">https://packaging.python.org/tutorials/packaging-projects/</a>
because we have a very non-Pythonic directory structure; in particular,
the subdirectories <cite>clawpack/x/</cite> do not have an <cite>__init__.py</cite>.</p>
<p>Here’s what to do, starting with a clean clone in some directory
referred to below as <cite>$TEMP</cite> (replace <cite>5.x.x</cite> by the new version number):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cd $TEMP
git clone https://github.com/clawpack/clawpack.git
cd clawpack # should now be in $TEMP/clawpack
source pull_all.sh
git submodule update --init --recursive
git-archive-all --prefix clawpack-5.x.x/ clawpack-5.x.x.tar

mv clawpack-5.x.x.tar ..
cd ..
tar -xf clawpack-5.x.x.tar # creates $TEMP/clawpack-5.x.x

cd clawpack
python3 setup.py sdist # creates $TEMP/clawpack/dist/clawpack-5.x.x.tar.gz
cd dist # should be in $TEMP/clawpack/dist
tar -xzf clawpack-5.x.x.tar.gz

cp clawpack-5.x.x/PKG-INFO ../../clawpack-5.x.x
rm -rf clawpack-5.x.x

cd ../.. # should be in $TEMP
rm clawpack-5.x.x.tar
tar -cf clawpack-5.x.x.tar clawpack-5.x.x
gzip clawpack-5.x.x.tar
mv clawpack-5.x.x.tar.gz clawpack/dist
<p>To release on the pypi server (for installation via pip) we
simply build from a clean clone and upload:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">clawpack</span><span class="o">/</span><span class="n">clawpack</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">clawpack</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">init</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span>
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">build</span>
</pre></div>
</div>
<p>Upload to the testpypi server for testing
(you will need to have created an account there):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">clawpack</span> <span class="c1"># should be in $TEMP/clawpack</span>
<span class="n">twine</span> <span class="n">upload</span> <span class="o">--</span><span class="n">repository</span><span class="o">-</span><span class="n">url</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">pypi</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">legacy</span><span class="o">/</span> <span class="n">dist</span><span class="o">/*</span>

<span class="n">credentials</span><span class="p">:</span> <span class="p">[[</span><span class="n">test</span> <span class="n">pypi</span><span class="p">]]</span>
<p>To upload to Pypi you need an account there and you must be listed as a
maintainer of Clawpack. Then you can update using
<a class="reference external" href="https://pypi.org/project/twine/">twine</a>.</p>
<p>You can first upload to the testpypi server for testing:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">twine</span> <span class="n">upload</span> <span class="o">--</span><span class="n">repository</span><span class="o">-</span><span class="n">url</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">pypi</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">legacy</span><span class="o">/</span> <span class="n">dist</span><span class="o">/*</span>
</pre></div>
</div>
<p>Click the link and check that it looks okay. You can also test via:</p>
<p>Click the link and check that it looks okay. You can also test installation via:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>pip3 uninstall clawpack
pip3 install —no-cache—dir —index-url https://test.pypi.org/simple/ clawpack
</pre></div>
Expand Down
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

62 changes: 21 additions & 41 deletions howto_release.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,14 @@ <h2>Preparation<a class="headerlink" href="#preparation" title="Permalink to thi
</section>
<section id="version-numbers">
<h2>Version numbers<a class="headerlink" href="#version-numbers" title="Permalink to this heading"></a></h2>
<p>Change the version number in <cite>clawpack/clawpack/__init__.py</cite>.
Initially set it to e.g. v5.4.1rc-alpha, then to the final release number.</p>
<p>The version number is also set in <cite>clawpack/setup.py</cite> and should be changed
there to be consistent with <cite>clawpack/clawpack/__init__.py</cite></p>
<p>Change the version number in the following files to the new version number:</p>
<blockquote>
<div><ul class="simple">
<li><p><cite>clawpack/clawpack/__init__.py</cite></p></li>
<li><p><cite>clawpack/setup.py</cite></p></li>
<li><p><cite>clawpack/pyproject.toml</cite></p></li>
</ul>
</div></blockquote>
</section>
<section id="release-candidates">
<h2>Release candidates<a class="headerlink" href="#release-candidates" title="Permalink to this heading"></a></h2>
Expand Down Expand Up @@ -190,47 +194,23 @@ <h2>Final release<a class="headerlink" href="#final-release" title="Permalink to
</section>
<section id="pypi">
<h2>Pypi<a class="headerlink" href="#pypi" title="Permalink to this heading"></a></h2>
<p>To release on the pypi server (for installation via pip) we have to do a bit
of trickery. We can’t just follow the directions at <a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/">https://packaging.python.org/tutorials/packaging-projects/</a>
because we have a very non-Pythonic directory structure; in particular,
the subdirectories <cite>clawpack/x/</cite> do not have an <cite>__init__.py</cite>.</p>
<p>Here’s what to do, starting with a clean clone in some directory
referred to below as <cite>$TEMP</cite> (replace <cite>5.x.x</cite> by the new version number):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cd $TEMP
git clone https://github.com/clawpack/clawpack.git
cd clawpack # should now be in $TEMP/clawpack
source pull_all.sh
git submodule update --init --recursive
git-archive-all --prefix clawpack-5.x.x/ clawpack-5.x.x.tar

mv clawpack-5.x.x.tar ..
cd ..
tar -xf clawpack-5.x.x.tar # creates $TEMP/clawpack-5.x.x

cd clawpack
python3 setup.py sdist # creates $TEMP/clawpack/dist/clawpack-5.x.x.tar.gz
cd dist # should be in $TEMP/clawpack/dist
tar -xzf clawpack-5.x.x.tar.gz

cp clawpack-5.x.x/PKG-INFO ../../clawpack-5.x.x
rm -rf clawpack-5.x.x

cd ../.. # should be in $TEMP
rm clawpack-5.x.x.tar
tar -cf clawpack-5.x.x.tar clawpack-5.x.x
gzip clawpack-5.x.x.tar
mv clawpack-5.x.x.tar.gz clawpack/dist
<p>To release on the pypi server (for installation via pip) we
simply build from a clean clone and upload:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">clawpack</span><span class="o">/</span><span class="n">clawpack</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">clawpack</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">init</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span>
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">build</span>
</pre></div>
</div>
<p>Upload to the testpypi server for testing
(you will need to have created an account there):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">clawpack</span> <span class="c1"># should be in $TEMP/clawpack</span>
<span class="n">twine</span> <span class="n">upload</span> <span class="o">--</span><span class="n">repository</span><span class="o">-</span><span class="n">url</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">pypi</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">legacy</span><span class="o">/</span> <span class="n">dist</span><span class="o">/*</span>

<span class="n">credentials</span><span class="p">:</span> <span class="p">[[</span><span class="n">test</span> <span class="n">pypi</span><span class="p">]]</span>
<p>To upload to Pypi you need an account there and you must be listed as a
maintainer of Clawpack. Then you can update using
<a class="reference external" href="https://pypi.org/project/twine/">twine</a>.</p>
<p>You can first upload to the testpypi server for testing:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">twine</span> <span class="n">upload</span> <span class="o">--</span><span class="n">repository</span><span class="o">-</span><span class="n">url</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">pypi</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">legacy</span><span class="o">/</span> <span class="n">dist</span><span class="o">/*</span>
</pre></div>
</div>
<p>Click the link and check that it looks okay. You can also test via:</p>
<p>Click the link and check that it looks okay. You can also test installation via:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>pip3 uninstall clawpack
pip3 install —no-cache—dir —index-url https://test.pypi.org/simple/ clawpack
</pre></div>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion v5.10.x/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 45368044918c8e987115991016a96479
config: 2c4272f4418f041866f06c8b8a57481e
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified v5.10.x/.doctrees/ClawPlotAxes.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/ClawPlotData.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/ClawPlotFigure.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/ClawPlotItem.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/about.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/adjoint.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/amr_algorithm.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/amrclaw.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/amrclaw1d.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/amrclaw_doxygen.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/amrclaw_flowcharts.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/application_documentation.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/apps.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/aws.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/b4run.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/b4step_defaults.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/bc.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/biblio.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/bouss1d.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/bouss2d.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/changes_to_master.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/claw43to46.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/claw46to50.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/claw4x.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/clawpack5.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/clawpack_components.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/community.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/contents.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/contribute_apps.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/current_data.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/developers.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/docker_image.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/dtopotools_module.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/environment.pickle
Binary file not shown.
Binary file modified v5.10.x/.doctrees/f77_vs_f90.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fgmax.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fgmax_tools_module.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fgout.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fgout_tools_module.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/first_run.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/first_run_fortran.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/first_run_pyclaw.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/flagregions.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/force_dry.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fortran.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fortran_compilers.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/fvmbook.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/galleries.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/gauges.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geoclaw.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geoclaw1d.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geoclaw_started.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geoclaw_util_module.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geohints.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/geoplot.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/git_versions.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/googleearth_plotting.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/gpu.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/grid_registration.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/howto_doc.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/howto_release.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/installing.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/installing_fortcodes.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/installing_pip.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/kmltools_module.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/lagrangian_gauges.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/license.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/makefiles.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/makefiles_library.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/manning.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/mapc2p.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/marching_front.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/matlab_plotting.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/nearshore_interp.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/netcdf.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/newapp.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/okada.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/openmp.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/output_styles.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/packages.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/photos.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/plotexamples.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/plotting.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/plotting_faq.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/plotting_geoclaw.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/plotting_python.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/prereqs.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/about.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/basics.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/classes.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/clawpack_and_pyclaw.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/cloud.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/controller.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/evolve/limiters.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/examples.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/geometry.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/going_further.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/index.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/io.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/output.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/parallel.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/plotting.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/problem.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/rp.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/solution.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/solvers.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/started.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/state.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/troubleshooting.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/tutorial.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/pyclaw/util.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/python.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/python_path.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/qinit_defaults.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/quick_surge.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/quick_tsunami.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/refinement.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/regression.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/release_5_0_0.doctree
Binary file not shown.
Binary file modified v5.10.x/.doctrees/release_5_10_0.doctree
Binary file not shown.
Loading

0 comments on commit 06514eb

Please sign in to comment.