Merge pull request #1 from HunterBelanger/develop

Merge Version 0.2.0

Author: HunterBelanger

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.9)
 
 project(PapillonNDL
-  VERSION "0.1.0"
+  VERSION "0.2.0"
   DESCRIPTION "Library to interact with ACE nuclear data"
   LANGUAGES CXX
 )
@@ -11,42 +11,47 @@ option(PNDL_GO_FASTER "Enable -Ofast -ffast-math compiler optimizations" OFF)
 option(PNDL_PYTHON "Enable Python interface to PapillonNDL" ON)
 option(PNDL_TESTS "Build tests" OFF)
 
-# Create PapillonNDL library target
-add_library(PapillonNDL SHARED
-  src/frame.cpp
-  src/interpolation.cpp
-  src/integration.cpp
-  src/region_1d.cpp
-  src/multi_region_1d.cpp
-  src/polynomial_1d.cpp
-  src/ace.cpp
-  src/isotropic.cpp
-  src/equiprobable_angle_bins.cpp
-  src/angle_table.cpp
-  src/equiprobable_energy_bins.cpp
-  src/level_inelastic_scatter.cpp
-  src/general_evaporation.cpp
-  src/evaporation.cpp
-  src/maxwellian.cpp
-  src/watt.cpp
-  src/tabular_energy.cpp
-  src/pctable.cpp
-  src/angle_distribution.cpp
-  src/uncorrelated.cpp
-  src/nbody.cpp
-  src/kalbach_table.cpp
-  src/kalbach.cpp
-  src/energy_angle_table.cpp
-  src/tabular_energy_angle.cpp
-  src/energy_grid.cpp
-  src/cross_section.cpp
-  src/reaction.cpp
-  src/delayed_group.cpp
-  src/fission_data.cpp
-  src/nuclide.cpp
-  src/version.cpp
+set(PNDL_SOURCE_LIST src/frame.cpp
+                     src/region_1d.cpp
+                     src/multi_region_1d.cpp
+                     src/polynomial_1d.cpp
+                     src/ace.cpp
+                     src/isotropic.cpp
+                     src/equiprobable_angle_bins.cpp
+                     src/angle_table.cpp
+                     src/equiprobable_energy_bins.cpp
+                     src/level_inelastic_scatter.cpp
+                     src/general_evaporation.cpp
+                     src/evaporation.cpp
+                     src/maxwellian.cpp
+                     src/watt.cpp
+                     src/tabular_energy.cpp
+                     src/pctable.cpp
+                     src/angle_distribution.cpp
+                     src/uncorrelated.cpp
+                     src/nbody.cpp
+                     src/kalbach_table.cpp
+                     src/kalbach.cpp
+                     src/energy_angle_table.cpp
+                     src/tabular_energy_angle.cpp
+                     src/energy_grid.cpp
+                     src/cross_section.cpp
+                     src/reaction.cpp
+                     src/delayed_group.cpp
+                     src/fission_data.cpp
+                     src/ce_neutron.cpp
+                     src/version.cpp
 )
 
+# Create PapillonNDL library target
+if(WIN32)
+  # On windows, make a static lib to avoid errors using cmake
+  add_library(PapillonNDL STATIC ${PNDL_SOURCE_LIST})
+else()
+  # On Unix-like systems, use a shared lib
+  add_library(PapillonNDL SHARED ${PNDL_SOURCE_LIST})
+endif()
+
 # Add public interface includes directory
 target_include_directories(PapillonNDL PUBLIC 
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
@@ -56,14 +61,17 @@ target_include_directories(PapillonNDL PUBLIC
 # Require C++17 standard
 target_compile_features(PapillonNDL PRIVATE cxx_std_17)
 
-# Get compiler info (MSVC/Clang/GCC)
-# TODO, for now, only support Clang or GCC
-
-# Set compile options for library
-target_compile_options(PapillonNDL PRIVATE -W -Wall -Wextra -Wpedantic -Weffc++)
-target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:DEBUG>:-g>)
-target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:RELEASE>:-O2>)
-target_compile_options(PapillonNDL PRIVATE $<$<BOOL:PNDL_GO_FASTER>:-Ofast -ffast-math>)
+if(WIN32) # Comile options for Windows
+  target_compile_options(PapillonNDL PRIVATE /W4)
+  target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:DEBUG>:/DEBUG>)
+  target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:RELEASE>:/O2>)
+  target_compile_options(PapillonNDL PRIVATE $<$<BOOL:PNDL_GO_FASTER>:/O2>)
+else() # Compile options for GCC and Clang on Unix-like systems
+  target_compile_options(PapillonNDL PRIVATE -W -Wall -Wextra -Wpedantic -Weffc++)
+  target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:DEBUG>:-g>)
+  target_compile_options(PapillonNDL PRIVATE $<$<CONFIG:RELEASE>:-O2>)
+  target_compile_options(PapillonNDL PRIVATE $<$<BOOL:PNDL_GO_FASTER>:-Ofast -ffast-math>)
+endif()
 
 if(PNDL_TESTS)
   add_subdirectory(tests)
@@ -88,10 +96,13 @@ if(PNDL_PYTHON)
                                     src/python/reaction.cpp
                                     src/python/delayed_group.cpp
                                     src/python/fission_data.cpp
-                                    src/python/nuclide.cpp
+                                    src/python/ce_neutron.cpp
                                     src/python/prng.cpp
   )
-
+  
+  # Require C++17 standard
+  target_compile_features(pyPapillonNDL PRIVATE cxx_std_17)
+  
   target_link_libraries(pyPapillonNDL PRIVATE PapillonNDL)
 
   # Get location for python lib

README.md

@@ -1,46 +1,46 @@
 # Papillon Nuclear Data Library
+[![Documentation Status](https://readthedocs.org/projects/papillon-ndl/badge/?version=latest)](https://papillon-ndl.readthedocs.io/en/latest/?badge=latest)
 ![License](https://img.shields.io/badge/License-CeCILL%20v2.1-brightgreen)
 
-The Papillon Nuclear Data Library (NDL) is used for reading, sampling,
-and interacting with continuous energy nuclear data, stored in the ACE
+The Papillon Nuclear Data Library (NDL) is a C++/Python library for reading,
+sampling, and interacting with continuous energy nuclear data, stored in the ACE
 nuclear data format.
 
-### Sampling
-To sample the angle and energy distributions, an instance of an
-```std::function<double()>``` must be passed to the distributions.
-This function pointer is the library's access to a pseudo random
-number generator. Therefore, if ```rng``` is such an instance, ```rng``` must
-meet the requirements that any call of ```rng()``` returns a random double over
-the interval [0,1), and it must be possible to call ```rng()``` an indefinite
-number of times. If the passed object does not meet these requirements, the
-behavior of the library is undefined. Using this mechanism allows greater
-flexibility to the user, in choosing the random number generator of their
-choice, and allows the library to be completely disconnected from the random
-number generation process, allowing the distributions to know how to sample
-themselves, but not know or assume anything about random number generation.
+For examples of how to use the library in both C++ and Python, take a look at
+the [documentation site](https://papillon-ndl.readthedocs.io). That is where you
+will also be able to fined more detailed installation instructions.
+
+## License
+PapillonNDL is provided under the terms and conditions of the CeCILLv2.1
+license. This is a French equivalent of the GPLv3 license, and is explicitly
+compatible with both the GPLv2 and v3. The French version of this license is
+provided in the LICENSE file, along with the equally valid English version, which
+may be found in the LICENSE-ENGLISH file. The CeCILLv2.1 is approved by the FSF.
+More information about this license may be found [here](https://cecill.info/).
 
 ## Dependencies
-To build and install the library a UNIX-like operating system with cmake >= 3.9
+To build and install the library a Unix-like operating system with cmake >= 3.9
 is required, along with a C++ compiler which supports the C++17 standard. The
-recommended compiler is Clang >= 5, though GCC >= 6 should suffice. In order to
+recommended compiler is Clang >= 6 or GCC >= 7 should suffice. In order to
 build the Python interface, Python >= 3.5 should be installed on your system, in
 addition to the Python development libraries and header files.
 
-Building the C++ library on Windows is in theory possible (and likely quite
-straight forward), though not currently supported. Building the Python bindings
-would likely be less trivial however with a standard Python installation for
-Windows. If you are a Windows user, I recommend that you take a look at the
-Windows Subsystem for Linux, which will allow you to build the library on your
-Windows machine, using the standard Linux build instructions.
+There are two posibilities for building the library on Windows. The first is to use
+the Windows Subsytem for Linux (WSL), where the library may be installed by following
+the simple Linux build instructions, typically without problem. The second option
+is to build the library to run natively on Windows. This requires having Visual
+Studio installed to compile the library. In addition, if you want to build the
+Python bindings for Windows, you need to ensure the Python development kit has been
+installed in Visual Studio as well.
 
 Building the unit tests (using ```-DPNDL_TESTS=ON``` when calling cmake)
 requires that Google test already be installed on the system, and is not
 provided. Tests are not built by default, and should only be needed for
 developers, therefore this is not required for most users.
 
 ## Install
-To build PapillonNDL, navigate to the directory where you would like to keep
-the source files, and then run the following commands:
+To build PapillonNDL on a Unix-like system, navigate to the directory where you
+would like to keep the source files, and then run the following commands:
 ```
 $ git clone https://github.com/HunterBelanger/papillon-ndl.git
 $ cd papillon-ndl
@@ -52,12 +52,4 @@ This will install the libraries and header files to the UNIX default locations
 in ```/usr/local/```.
 
 If you do NOT want to build the Python bindings for PapillonNDL, then you should
-add the flag ```-DPNDL_PYTHON=OFF``` to the cmake command.
-
-## License
-PapillonNDL is provided under the terms and conditions of the CeCILLv2.1
-license. This is a French equivalent of the GPLv3 license, and is explicitly
-compatible with both the GPLv2 and v3. The French version of this license is
-provided in the LICENSE file, along with the equally valid English version, which
-may be found in the LICENSE-ENGLISH file. The CeCILLv2.1 is approved by the FSF.
-More information about this license may be found [here](https://cecill.info/).
+add the flag ```-DPNDL_PYTHON=OFF``` to the cmake command.