radiasoft / electroncooling

Jlab Simulation Package for Electron Cooling

About JSPEC

JSPEC is an open source C++ package for numerical simulations on the electron cooling process, including the intrabeam scattering (IBS) effect, developed at Jefferson Lab (JLab).

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

How to compile

Compile using code blocks IDE

JSPEC is developed using the code blocks IDE. If you are using the same IDE, just open the project file "jspec.cbp" in the cbp folder and build it. Make sure you have a c++ compiler that supports C++11 standard.

Compile using cmake

Users can also use cmake to compile the files (tested in Ubuntu 16.06). In the project folder, run the following commands:

cd build

cmake ..

make

Test

Users can validate the compiliation by using the included testing functions

make test

One can aid with diagnosing testing problems by using the verbose version of this action:

ctest -VV

How to run

To run JSPEC, you can put your input file in the same folder with the JSPEC executable file and run the following commands in the folder:

jspec.exe inputfilename

You also need another file in MAD X tfs format, which defines the ion ring optics. You can put it in the same folder too. About how to write your input file, please refer to the JSPEC User Manual.

Acknowledgement

Authors of BETACOOL, we learned a lot from BETACOOL.

Authors of muParser, which is used in building the text-base UI.

Dr. David Bruwihler and Paul Moeller at Radiasoft, who developed an online version of JSPEC with GUI on their cloud server, Sirepo.

Contact the authors

Dr. He Huang at Old Dominion University by hhuang.AT.odu.edu

Dr. He Zhang at Jefferson Lab by hezhang.AT.jlab.org.

electroncooling's Issues

Correction to unmagnetized model

A user indicated that a pre-cooler design was giving different unmagnetized cooling rates depending on the model. Following up, it looks like the Binney Approximation solution to the unmagnetized model has a sign error. This is shown in the plot below. This fix should be very simple.