Skip to content
Snippets Groups Projects
Commit e473ac52 authored by Nico's avatar Nico
Browse files

Update Documentation...

parent 5d8fa0d0
No related branches found
No related tags found
No related merge requests found
......@@ -13,14 +13,7 @@
\vspace{2cm}
CLASS stands for \textbf{C}ore \textbf{L}ibrary for \textbf{A}dvanced \textbf{S}cenario \textbf{S}imulation. CLASS is developed from a \textbf{CNRS\footnote{Centre National de la Recherche Scientifique}/IRSN\footnote{Institut de Radioprotection et de S\^{u}ret\'{e} Nucl\'{e}aire}} collaboration started in 2012. It is an \textbf{open source} package of C++ libraries.
CLASS is a \textbf{dynamical fuel cycle simulation tool}. It allows to \textbf{simulate} the evolution of an entire \textbf{nuclear reactor fleet} and its associated facilities, such as spent fuel pool, fuel fabrication plant, chemical separation plant, disposal and so on.
Switching from a technology of reactor, or enrichment , or reprocessing,... to an other can strongly impact several quantities such as the resource consumption, waste disposal surface, spent fuel transportation frequency, and so on. The goal of a nuclear fuel cycle code is to calculate nuclei inventories and mass flows evolution in an entire fuel cycle, from the mine to the final disposal in order to \textbf{evaluates the impacts of the changes in a civil nuclear policy of a country}.
The heart of such codes is located in the treatment of the fuel fabrication and its depletion in reactor. CLASS main asset is its ability to include any kind of reactor, either the system is innovative or standard. Indeed, the opportunity is given to each user to \textbf{build his own reactor model}. CLASS aims to be a useful tool for scenarios studies involving \textbf{Generation IV reactors} transitions as well as innovative fuel cycles, such as the Thorium cycle.
The code CLASS (\textbf{C}ore \textbf{L}ibrary for \textbf{A}dvanced \textbf{S}cenario \textbf{S}imulation) is a dynamic fuel cycle simulation tool developed by CNRS/IN2P3 (Centre National de la Recherche Scientifique / Institut National de Physique Nucléaire et de Physique des Particules) in collaboration with IRSN (Institut de Radioprotection et de Sûreté Nucléaire). The aim of the tool CLASS is to model an evolving electro-nuclear fleet. The main output is the evolution of isotopes in all facilities of a nuclear fleet. The reactor physics is located in the treatment of the fuel fabrication and its depletion in reactor. The code CLASS aims to be a useful tool for scenarios studies. CLASS main asset is its ability to implement any kind of reactor, either the system is innovative or standard. Indeed, the opportunity is given to each user to \textbf{build his own reactor model}.
\part{First Steps}
\chapter{Package Content}
......@@ -32,11 +25,14 @@ The CLASS package contains the followings :
\subitem \textbf{Mass.dat } : file containing molar masses
\subitem \textbf{SpontaneousFPyield.dat } : file containing spontaneous fission yields
\subitem \textbf{chart.JEF3T} : file containing decay constants and branching ratios
\subitem \textbf{HeatTox.dat} : file containing conversion data for heat and radiotoxicity calculation
\item \textbf{DATA\_BASES/} : this folder contains decay data base and reactor data bases
\subitem \textbf{DECAY/} : decay data base
\subitem \textbf{FBR-Na/} : Models related to Fast reactor
\subitem \textbf{PWR/} : Models related to Pressurised Water Reactor
\subitem \textbf{REP_HFC/} : Models related to low moderated Pressurised Water Reactor
\subitem \textbf{ADS/} : Models related to Accelerator Driven System
\item \textbf{documentation/}
\subitem \textbf{Manual/} : folder containing this user guide an its .tex sources
......@@ -45,9 +41,12 @@ The CLASS package contains the followings :
\item \textbf{example/} : folder containing simple examples of CLASS input and an example of CLASS ouput reader
\item \textbf{gui/} : folder containing sources of the graphical user interface for CLASS outputs
\subitem \textbf{bin/} : folder containing the CLASSGui binary (once comiled)
\item \textbf{lib/} : folder containing the CLASS library (once compiled)
\item \textbf{bin/} : folder containing the CLASSGui binary (once comiled)
\item \textbf{source/} : folder containing CLASS sources
\subitem \textbf{include/}
\subitem \textbf{Model/} : folder that contain the sources related to the physics models (EquivalenceModel , XSModel and IrradiationModel)
......
File deleted
\documentclass[a4paper,11pt]{report}
\usepackage{bstyle}
%----------------------------------------------------------------------------------------
% BLANK DOCUMENT
%----------------------------------------------------------------------------------------
\titleformat{\chapter}[frame]
{\LARGE}{\filleft\enspace \@Chapter~\thechapter\enspace}
{15pt}{\LARGE\bfseries\filcenter}
\titlespacing*{\chapter}
{0pt}{0pt}{40pt}
%% --------- MAIN -------------
\begin{document}
\thispagestyle{empty}
\titleGM % This command includes the title page
% === title and abst. ===
\newgeometry{top=2cm, bottom=1.5cm, left=2.5cm, right=2cm}
\pagenumbering{roman}
\tableofcontents % Table des matires
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : INTRODUCTION
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{Introduction}
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : GENERAL OVERVIEW
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{GeneralOverview}
%%%%%%
%% CHAPTER : Physics MODEL
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{PhysicsModel}
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : CLASSGUI
%%%%%%%%%%%%%%%%%%%%%%%%%
\part{CLASSGui : The results viewer}
\label{part:GUI}
To use the CLASSGui :
\begin{center}
\begin{minipage}{\textwidth}
\begin{lstlisting}
CLASSGui MyCLASSOutput.root
\end{lstlisting}
\end{minipage}
\end{center}
\begin{figure}[h!]
\centering
\includegraphics[width=0.7\textwidth]{CLASSGui}
\caption{The graphical user interface for CLASS outputs\label{fig:CLASSGui} }
\end{figure}
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : INPUT EXAMPLE
%%%%%%%%%%%%%%%%%%%%%%%%%
%\part{Input examples}
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : IN DEVELOPMENT
%%%%%%%%%%%%%%%%%%%%%%%%%
%\part{In development}
% === main matter ===
%\mainmatter
%\linenumbers
%\part{Recherche de la Vibration G\'eante de Paires}
%\include{ithemba_chapter_1_intro}
%\include{ithemba_chapter_2_des_exp}
%\include{ithemba_chapter_3_analyse}
%\include{ithemba_chapter_4_crosssection}
%\include{ithemba_chapter_5_discussion}
%\part{Mesure du temps de vie du premier tat excit $2^{+}$ du $^{74}$Zn par m\'ethode plunger.}
\bibliographystyle{wmaainf}
\bibliography{Biblio}
\end{document}
......@@ -19,27 +19,29 @@
\newgeometry{top=2cm, bottom=1.5cm, left=2.5cm, right=2cm}
\pagenumbering{roman}
\tableofcontents % Table des matières
\tableofcontents % Table des matires
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : INTRODUCTION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : INTRODUCTION
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{Introduction}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : GENERAL OVERVIEW
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : GENERAL OVERVIEW
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{GeneralOverview}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : Physics MODEL
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%
%% CHAPTER : Physics MODEL
%%%%%%%%%%%%%%%%%%%%%%%%%
\include{PhysicsModel}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%
%% CHAPTER : CLASSGUI
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%
\part{CLASSGui : The results viewer}
\label{part:GUI}
To use the CLASSGui :
......@@ -84,7 +86,7 @@ CLASSGui MyCLASSOutput.root
%\include{ithemba_chapter_3_analyse}
%\include{ithemba_chapter_4_crosssection}
%\include{ithemba_chapter_5_discussion}
%\part{Mesure du temps de vie du premier état excité $2^{+}$ du $^{74}$Zn par m\'ethode plunger.}
%\part{Mesure du temps de vie du premier tat excit $2^{+}$ du $^{74}$Zn par m\'ethode plunger.}
\bibliographystyle{wmaainf}
\bibliography{Biblio}
......
......@@ -117,16 +117,17 @@
\hspace*{0.05\textwidth} % Whitespace between the vertical line and title page text
\parbox[b]{0.75\textwidth}{ % Paragraph box which restricts text to less than the width of the page
{\noindent\Huge\bfseries User Guide - CLASS v4.1 }\\[2\baselineskip] % Title
{\large \textit{Core Library for Advanced Scenario Simulation}}\\[4\baselineskip] % Tagline or further description
{\Large \textsc{ B. LENIAU$^{1}$ \& B. MOUGINOT$^{2}$ }}\\ % Author name
{\noindent\Huge\bfseries User Guide - CLASS v5 }\\[2\baselineskip] % Title
{\large \textit{Core Library for Advanced Scenarios Simulations}}\\[4\baselineskip] % Tagline or further description
%{\Large \textsc{ B. LENIAU$^{1}$ \& B. MOUGINOT$^{2}$ }}\\ % Author name
\\
%Author mail
$^{1}$ \href{Baptiste.Leniau@subatech.in2p3.fr}{Baptiste.Leniau@subatech.in2p3.fr}\\
$^{2}$ \href{Baptiste.Mouginot@subatech.in2p3.fr}{Baptiste.Mouginot@subatech.in2p3.fr}\\
%$^{1}$ \href{Baptiste.Leniau@subatech.in2p3.fr}{Baptiste.Leniau@subatech.in2p3.fr}\\
%$^{2}$ \href{Baptiste.Mouginot@subatech.in2p3.fr}{Baptiste.Mouginot@subatech.in2p3.fr}\\
\vspace{0.5\textheight} % Whitespace between the title block and the publisher
{\noindent CNRS:IN2P3:Subatech:Erdre \\ Release date : }\\[\baselineskip] % Publisher and logo
{\noindent CNRS/IN2P3 \\ Release date : 03/05/2018}\\[\baselineskip] % Publisher and logo
Copyright 2012 CNRS
}}
\endgroup}
\setcounter{tocdepth}{3}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment