Skip to content

Commit

Permalink
Merge pull request #460 from lukasmerten/cleanup
Browse files Browse the repository at this point in the history
Cleanup
  • Loading branch information
lukasmerten authored Jan 9, 2024
2 parents b771a83 + 6ab72c7 commit 12105f4
Show file tree
Hide file tree
Showing 16 changed files with 17 additions and 149 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## CRPropa vNext

### Bug fixes:
* Fixed sign for exponential decay of magn. field strength with Galactic height in LogarithmicSpiralField

### New features:

Expand All @@ -9,6 +10,8 @@
### Features that are deprecated and will be removed after this release

### Removed features
* AMRMagneticField - underlying library (saga) is no longer supported.
* ObserverPoint: Use Observer1D instead.

### New plugins and resources linked on the webpages

Expand Down
11 changes: 0 additions & 11 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -245,17 +245,6 @@ if(ENABLE_QUIMBY)
endif(QUIMBY_FOUND)
endif(ENABLE_QUIMBY)

# SAGA (optinal for AMR grids)
find_package(SAGA)
if(SAGA_FOUND)
list(APPEND CRPROPA_EXTRA_INCLUDES ${SAGA_INCLUDE_DIR})
list(APPEND CRPROPA_EXTRA_LIBRARIES ${SAGA_LIBRARY})
add_definitions (-DCRPROPA_HAVE_SAGA)
list(APPEND CRPROPA_SWIG_DEFINES -DCRPROPA_HAVE_SAGA)
list(APPEND SWIG_INCLUDE_DIRECTORIES ${SAGA_INCLUDE_DIR}/../python)
list(APPEND SWIG_INCLUDE_DIRECTORIES ${SAGA_INCLUDE_DIR})
endif(SAGA_FOUND)

# muparser (optional for generic source spectra)
find_package(muParser)
if(MUPARSER_FOUND)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CRPropa
========

![stable release](https://img.shields.io/badge/stable\_release-3.2.0-darkblue)
![stable release](https://img.shields.io/badge/stable\_release-3.2.1-darkblue)
[![Build status](https://github.com/crpropa/crpropa3/actions/workflows/testing.yml/badge.svg)](https://github.com/crpropa/crpropa3/actions/)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/CRPropa/CRPropa3.svg)](https://isitmaintained.com/project/CRPropa/CRPropa3)
[![Percentage of issues still open](https://isitmaintained.com/badge/open/CRPropa/CRPropa3.svg)](https://isitmaintained.com/project/CRPropa/CRPropa3)
Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
# -- Project information -----------------------------------------------------

project = u'CRPropa3'
copyright = u'2022, The CRPropa Developers'
copyright = u'2024, The CRPropa Developers'
author = u'The CRPropa Developers'

# The short X.Y version
version = u'3.2'
# The full version, including alpha/beta/rc tags
release = u'3.2.0'
release = u'3.2.1'


# -- General configuration ---------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions doc/pages/Data-files.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CRPropa needs a number of data files to run. These include databases for nuclear mass and decay rates, interaction rates for photodisintegration, photo-pion production and electron-pair production, as well as the data files for DINT and EleCa.
CRPropa needs a number of data files to run. These include databases for nuclear mass and decay rates, interaction rates for photodisintegration, photo-pion production and electron-pair production.
The scripts and files that are used to prepare the data files are tracked by the [CRPropa3-data repository](https://github.com/CRPropa/CRPropa3-data).

Since a git repository is not well suited to store these large files (and git-lfs is not free on GitHub), the data files are downloaded automatically during cmake configuration. In case you want to use a different photodisintegration model or want to download the default data file manually use the following [link](https://www.desy.de/~crpropa/data/interaction_data/) to the tarballs files and extract them to your install folder.
Expand All @@ -21,7 +21,7 @@ $ ls data-YYYY-MM-DD.tar.gz | xargs -I{} sh -c 'md5sum "$1" > "$1-CHECKSUM"' --
```
where **YYYY-MM-DD** can be obtained directly with `date +"%Y-%m-%d"`.

To verify the integrity of the data files, a it is enough to download the checksum file in the same directory with the data file:
To verify the integrity of the data files, it is enough to download the checksum file in the same directory with the data file:
```
$ md5sum -c *-CHECKSUM
```
Expand Down
4 changes: 0 additions & 4 deletions doc/pages/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Optionally CRPropa can be compiled with the following dependencies to enable cer

The following packages are provided with the source code and do not need to be installed separately.
+ SOPHIA: photo-hadronic interactions
+ EleCa and dint: electromagnetic cascades
+ googletest: unit-testing
+ HepPID: particle ID library
+ kiss: small tool collection
Expand All @@ -31,9 +30,6 @@ The following packages are provided with the source code and do not need to be i
+ healpix_base: Equal area pixelization of the sphere





## Build and Installation Variants
### Installation in system path

Expand Down
1 change: 0 additions & 1 deletion include/CRPropa.h
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
#include "crpropa/module/TextOutput.h"
#include "crpropa/module/Tools.h"

#include "crpropa/magneticField/AMRMagneticField.h"
#include "crpropa/magneticField/ArchimedeanSpiralField.h"
#include "crpropa/magneticField/JF12Field.h"
#include "crpropa/magneticField/JF12FieldSolenoidal.h"
Expand Down
88 changes: 0 additions & 88 deletions include/crpropa/magneticField/AMRMagneticField.h

This file was deleted.

13 changes: 0 additions & 13 deletions include/crpropa/module/Observer.h
Original file line number Diff line number Diff line change
Expand Up @@ -121,19 +121,6 @@ class ObserverTracking: public ObserverFeature {
};


/**
@class ObserverPoint
@brief Detects particles when reaching x = 0
Should be removed and replaced by Observer1D
*/
class ObserverPoint: public ObserverFeature {
public:
DetectionState checkDetection(Candidate *candidate) const;
std::string getDescription() const;
};


/**
@class Observer1D
@brief Detects particles when reaching x = 0
Expand Down
2 changes: 1 addition & 1 deletion libs/HepPID/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 2.6)
cmake_minimum_required(VERSION 3.14)

include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)

Expand Down
2 changes: 1 addition & 1 deletion libs/gtest/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ endif()
# ${gtest_BINARY_DIR}.
# Language "C" is required for find_package(Threads).
project(gtest CXX C)
cmake_minimum_required(VERSION 2.6.2)
cmake_minimum_required(VERSION 3.14)

if (COMMAND set_up_hermetic_build)
set_up_hermetic_build()
Expand Down
2 changes: 1 addition & 1 deletion libs/healpix_base/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 2.6)
cmake_minimum_required(VERSION 3.14)

include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)

Expand Down
10 changes: 5 additions & 5 deletions libs/kiss/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
cmake_minimum_required(VERSION 2.6)
cmake_minimum_required(VERSION 3.14)

include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)

add_library(kiss STATIC
src/logger
src/path
src/string
src/uuid
src/logger.cpp
src/path.cpp
src/string.cpp
src/uuid.cpp
)

SET_TARGET_PROPERTIES( kiss PROPERTIES COMPILE_FLAGS -fPIC)
Expand Down
2 changes: 1 addition & 1 deletion libs/sophia/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 2.6)
cmake_minimum_required(VERSION 3.14)

enable_language(Fortran)

Expand Down
1 change: 0 additions & 1 deletion python/2_headers.i
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,6 @@ using namespace crpropa; // for usage of namespace in header files, necessary
%include "crpropa/magneticField/GalacticMagneticField.h"
%feature("notabstract") QuimbyMagneticFieldAdapter;
%include "crpropa/magneticField/QuimbyMagneticField.h"
%include "crpropa/magneticField/AMRMagneticField.h"
%include "crpropa/magneticField/JF12Field.h"
%include "crpropa/magneticField/JF12FieldSolenoidal.h"
%include "crpropa/magneticField/PolarizedSingleModeMagneticField.h"
Expand Down
17 changes: 0 additions & 17 deletions src/module/Observer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -133,23 +133,6 @@ std::string ObserverTracking::getDescription() const {
return ss.str();
}

// ObserverPoint --------------------------------------------------------------
DetectionState ObserverPoint::checkDetection(Candidate *candidate) const {
KISS_LOG_WARNING << "ObserverPoint is deprecated and is no longer supported. Please use Observer1D instead.\n";
double x = candidate->current.getPosition().x;
if (x > 0) {
// Limits the next step size to prevent candidates from overshooting in case of non-detection
candidate->limitNextStep(x);
return NOTHING;
}
// Detects particles when reaching x = 0
return DETECTED;
}

std::string ObserverPoint::getDescription() const {
return "ObserverPoint: observer at x = 0";
}

// Observer1D --------------------------------------------------------------
DetectionState Observer1D::checkDetection(Candidate *candidate) const {
double x = candidate->current.getPosition().x;
Expand Down

0 comments on commit 12105f4

Please sign in to comment.