You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: webdocs/bug.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ Reporting GSAS-II Bugs
8
8
=======================
9
9
10
10
GSAS-II is being actively developed with new features regularly being added. Alas,
11
-
as new features are added or bugs are fixed, we inadvertently create bugs in things that previously worked. Unless we know about the bug, it will likely never be fixed. Usually we need sample data to reproduce the bug and so we know we have fixed it. Even if your bug is in the middle of a tutorial, please provide the GSAS-II project file so that we know exactly where the problem occurred (and so that we don't need to redo all the steps before that point so we can reproduce the problem.) Easy-to-find bugs tend to get fixed faster.
11
+
as new features are added or bugs are fixed, we may inadvertently create bugs in things that previously worked. Unless we know about the bug, we will not know it needs to be fixed. Usually we need sample data to reproduce the bug and so we know we have fixed it. Even if your bug occurs in the middle of a tutorial, please provide the GSAS-II project file so that we know exactly where the problem occurred (and so that we don't need to redo all the steps before that point so we can reproduce the problem.) Easy-to-find bugs tend to get fixed faster.
12
12
13
-
**Important**: has the bug you are seeing already been fixed? Before reporting something as a bug, please update to the latest version of GSAS-II (see Help-->"Check for Updates") and test again to confirm that the problem still exists. If you report a bug with GSAS-II and your version is more than a few days old, we will probably ask you to update and confirm before we look at it. We do try to fix bugs as soon as we hear about them and sometimes have bug fixes posted within hours.
13
+
**Important**: has the bug you are seeing already been fixed? Before reporting a bug, please update to the latest version of GSAS-II (see Help-->"Check for Updates") and test again to confirm that the problem still exists. If you report a bug with GSAS-II and your version is more than a few days old, we will probably ask you to update and confirm before we look at it. We do try to fix bugs as soon as we hear about them and sometimes have bug fixes posted within hours.
14
14
15
15
With our transiton to GitHub, bugs and enhancement requests will be found in the `GitHub Issues Tracker <https://github.com/AdvancedPhotonSource/GSAS-II/issues>`_. This will help in finding and fixing problems as well as letting people know what has been fixed and avoid us pursuing duplicates. Having a a centralized list of things that people are asking for will also be useful and may help us grow community support. Finally, the issues tracker will keep a record of the bugs that have been fixed, how they were addressed and when.
16
16
@@ -22,13 +22,13 @@ What to report
22
22
23
23
When reporting a bug,
24
24
25
-
0) Please confirm you are using the newest GSAS-II version (see Help-->"Check for Updates"). We get kind-of-annoyed after spending an hour figuring out what is going wrong, only to discover that it is something that was fixed, last week or last month.
25
+
0) Please confirm you are using the newest GSAS-II version (see Help-->"Check for Updates"). We get grumpy after spending an hour or more with figuring out what is giving rise to your problem, only to discover that it is something that was already fixed.
26
26
27
-
1) Attach your project (.gpx) file. Even when requesting an enhancement, providing that so that we have example data to work from is very helpful. If your file contains unpublished data that you would rather not post, please remove/replace information on atoms/composition so that your data will not be very informative. Alternately see if you can reproduce the problem with data that you can post. If there is no other choice, you can let us know to ask you directly for the .gpx file, which will not be posted.
27
+
1) Attach your project (.gpx) file. Even if requesting an enhancement, providing an example that so that we have data to work from greatly helps us. If your project contains unpublished data that you would rather not post, please remove/replace information on atoms/composition so that your data will not be very informative. Alternately, perhaps you can reproduce the bug with other data that you would be comfortable posting. Another choice is to post the bug in GitHub, but supply the project to us directly via e-mail. We will not share that.
28
28
29
29
2) Note that .gpx files do not contain images, so problems in image processing will also require that you provide the relevant image(s).
30
30
31
-
3) Another very helpful source of information when tracking down bugs will be the contents of the GSAS-II console (terminal) window, as that will usually show error messages and a trace of the Python commands involved. You can either highlight the contents and use copy-and-paste or provide a screen dump, At a minimum provide all lines beginning with "Traceback (most recent call..."], but ideally we would like to see all the pages from when GSAS-II is first started, which may require that you scroll up to give us a complete idea of what is going wrong.
31
+
3) Another very helpful source of information when tracking down bugs will be the contents of the GSAS-II console (terminal) window, as that will usually show error messages and a trace of the Python commands involved. You can either highlight the contents and use copy-and-paste or provide a screen dump, At a minimum, provide all lines beginning with "Traceback (most recent call..."], but ideally we would like to see all the pages from when GSAS-II is first started, which may require that you scroll up to give us a complete idea of what is going wrong. A screen image is helpful, but cut-and-paste from the console window works well too.
32
32
33
33
On occasion, we may ask to schedule a Zoom or Teams with you to see exactly what you are doing or to look further at a bug we cannot reproduce.
34
34
@@ -38,7 +38,7 @@ On occasion, we may ask to schedule a Zoom or Teams with you to see exactly what
38
38
How to report
39
39
------------------
40
40
41
-
Our preferred mechanism for bug reporting is to use the GitHub `Issues tracker <https://github.com/AdvancedPhotonSource/GSAS-II/issues>`_. If you do not already have an account on GitHub, you will need one (it's free) to create or comment on a report, but anyone can see what is there. When creating an issue report, please describe the problem and add files and images to help us duplicate and fix the problem (see above). We will accept bug reports by e-mail, but would rather not get them that way. We may put e-mailed bugs into the issues tracker, unless you tell us not to do that.
41
+
Our preferred mechanism for bug reporting is to use the GitHub `Issues tracker <https://github.com/AdvancedPhotonSource/GSAS-II/issues>`_. If you do not already have an account on GitHub, you will need one (it's free) to create or comment on a report, but anyone can see what is there. When creating an issue report, please describe the problem and add files and images to help us duplicate and fix the problem (see above). We will also accept bug reports by e-mail if you really prefer to not use GitHub yourself. The same info is needed, but can be e-mailed to Brian or Bob (if needed, make an initial contact via "send e-mail" on `Argonne's page for Brian <https://www.anl.gov/profile/brian-h-toby>`_). We may create a GitHub issue for the bug so we don't lose track of it before addressing it, but will keep your name and sample/data information off the entry.
Copy file name to clipboardExpand all lines: webdocs/install.rst
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
:align:right
5
5
6
6
============================================
7
-
Overview of GSAS-II Installation Methods
7
+
Installing GSAS-II: Overview
8
8
============================================
9
9
10
10
.. index:: Installation overview
@@ -37,7 +37,12 @@ For MacOS and Linux use a command such as::
37
37
38
38
where:
39
39
40
-
* <platform> is replaced by ``Linux-x86_64.sh`` for Linux, ``MacOSX-arm64.sh`` for MacOS with "Apple Silicon" (M1, etc.) processors and ``MacOSX-x86_64.sh`` is for older Intel-based machines. Note that the ``MacOSX-x86_64.sh`` installer will run on "Apple Silicon" processors, but significantly more slowly.
40
+
* <platform> is replaced by ``Linux-x86_64.sh`` for Linux, ``MacOSX-arm64.sh`` for MacOS with "Apple Silicon" (M1, etc.) processors and ``MacOSX-x86_64.sh`` is for older Intel-based machines. Note that the ``MacOSX-x86_64.sh`` installer will run on "Apple Silicon" processors, but significantly more slowly. Thus choices are::
* <install-loc> is where you want to install the software. (Use of ``~/g2full``, a subdirectory named ``g2full`` in your home directory is a good choice.) After installation is complete, you may be asked if you want to place a shortcut for GSAS-II into the MacOS dock.
42
47
43
48
More complete installation instructions are provided for `MacOS <install-g2f-mac.html>`_ and `Linux <install-g2f-linux.html>`_.
0 commit comments