forked from dkriegner/xrayutilities
-
Notifications
You must be signed in to change notification settings - Fork 0
/
release.txt
100 lines (65 loc) · 2.98 KB
/
release.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
This document describes the process of making a new release of xrayutilities.
this procedure is intended for use on a Unix operating system.
CHECK EVERYTHING
================
Is everything running fine? perform the tests and run the examples
# change the version in VERSION
python2 setup.py test
python3 setup.py test
# optionally check the coverage
coverage run --source xrayutilities setup.py test
coverage html --omit='test_*'
run the examples
UPDATE DOCUMENTATION
====================
to build the documentation from scratch first one needs to rebuild the API
documentation sources (which is done from the installed module, so make sure
you have the latest version installed!)
sphinx-apidoc -f -o doc/source xrayutilities
In the root directory of the package execute the following to rebuild the documentation pdf
python setup.py build build_doc -b pdf
cd build/sphinx/pdf; pdftk xrayutilities.pdf output ../../../xrayutilities.pdf ; cd ../../..
PACKAGING
=========
create a tarball for redistribution of xrayutilities without the use of git
python setup.py sdist
creates a tarball in the directory dist, which contains everything needed for
the installation of xrayutilities
This tarball should be uploaded to sourceforge and PyPI.
To build a executable installer for Microsoft windows run
python setup.py bdist_wininst
on a windows machine.
If not done previously you need to build the extenstion modules using
python setup.py build -c <compiler_name>
The compiler name can be omitted if the default is working.
To build for 64-bit Windows, a known way to do it was reported by RG is
using MS Visual Studio Express 2008 (which is freely available for download).
To perform the installation or build a installer package perform the
following steps:
* open an administrator shell
* execute: 'set DISTUTILS_USE_SDK=1'
* execute: 'setenv /x64 /release' (use /x86 for a 32-bit build)
* compile with: 'python setup.py build -c msvc' which should give you
the chance to run 'python setup.py bdist_wininst' or install.
See https://github.com/cython/cython/wiki/64BitCythonExtensionsOnWindows
for details.
UPDATE WEBPAGE
==============
rebuild the html documents and upload them to the sourceforge webserver
to have the correct style the style file needs to patched
python setup.py build_doc -b html
patch -p0 < doc/webpage.patch
# in case its needed, update the patch with
# diff -Naur build/sphinx/html/index.html.orig build/sphinx/html/index.html > doc/webpage.patch
to upload new web-documentation connect to the sourceforge server via:
sftp://USERNAME@web.sourceforge.net
/home/project-web/xrayutilities/htdocs
files on sourceforge can be moved/archived using
sftp://USERNAME@frs.sourceforge.net/home/frs/project/x/xr/xrayutilities
however upon such a move the download statistics are lost.
UPDATE PyPI PACKAGE
===================
Upload new version to the Python package index by
python setup.py sdist upload
On a windows machine run
python setup.py bdist_wininst upload