forked from SmileiPIC/Smilei
-
Notifications
You must be signed in to change notification settings - Fork 0
a collaborative, open-source, multi-purpose particle-in-cell code for plasma simulation
unpairedbracket/Smilei
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Licence — Smilei v4.1-163-g011c2ce8 documentation</title> <link rel="stylesheet" href="_static/smilei_theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <script async="async" type="text/javascript" src="https://www.gitcdn.xyz/repo/mathjax/MathJax/master/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <link rel="shortcut icon" href="_static/smileiIcon.ico"/> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Synopsis" href="synopsis.html" /> <link rel="prev" title="<no title>" href="index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <script type="text/x-mathjax-config"> MathJax.Hub.Config({ "HTML-CSS": { scale: 95, availableFonts: ["TeX"] } }); </script> </head><body> <div id="smallScreenMenu" class="off"> <div class="toctree-smilei"> <ul> </ul> <ul> <li><a class="reference internal" href="#">Licence</a><ul> <li><a class="reference internal" href="#how-to-cite-smilei">How to cite Smilei</a></li> </ul> </li> </ul> <ul> <li class="outer"> <a href="synopsis.html">Synopsis</a> </li> <li class="outer"> <a href="highlights.html">Highlights</a> </li> <li class="outer"> <a href="releases.html">Releases</a> </li> </ul> <hr /> <ul> <li class="outer"> <a href="units.html">Units</a> </li> <li class="outer"> <a href="algorithms.html">PIC algorithms</a> </li> <li class="outer"> <a href="parallelization.html">Parallelization basics</a> </li> <li class="outer"> <a href="vectorization.html">Vectorization</a> </li> <li class="outer"> <a href="collisions.html">Binary collisions</a> </li> <li class="outer"> <a href="ionization.html">Ionization</a> </li> <li class="outer"> <a href="radiation_loss.html">Synchrotron-like radiation reaction</a> </li> <li class="outer"> <a href="multiphoton_Breit_Wheeler.html">Multiphoton Breit-Wheeler pair creation</a> </li> <li class="outer"> <a href="laser_envelope.html">Laser envelope model</a> </li> <li class="outer"> <a href="relativistic_fields_initialization.html">Field initialization for relativistic species</a> </li> </ul> <hr /> <ul> <li class="outer"> <a href="installation.html">Install</a> </li> <li class="outer"> <a href="namelist.html">Write a namelist</a> </li> <li class="outer"> <a href="run.html">Run</a> </li> <li class="outer"> <a href="post-processing.html">Post-process</a> </li> <li class="outer"> <a href="contribute.html">Contribute</a> </li> </ul> <hr /> <ul> <li class="outer"> <a href="material.html">Publications</a> </li> <li class="outer"> <a href="partners.html">Partners</a> </li> <li class="outer"> <a href="https://smileipic.github.io/tutorials">Smilei tutorials</a> </li> </ul> </div> </div> <div id="hcontainer"> <div id="nav_positioner"> <div id="nav"> <div id="nav_button" onclick="toggleNav()"> Sections </div> <div id="nav_list" class="toctree-smilei"> <div id="nav_title"><a href="#">Licence</a></div> <ul> <li><a class="reference internal" href="#">Licence</a><ul> <li><a class="reference internal" href="#how-to-cite-smilei">How to cite Smilei</a></li> </ul> </li> </ul> </div> </div> </div> <div class="headercolor"> </div> <div class="hpositioner"> <div class="header"> <div class="logo"> <a href="index.html"> <img class="logo" src="_static/smileiLogo.svg" alt="Logo" /> </a> </div> <div class="menu" id="menu_Licence" style="font-weight:bold"> <div id="menuButton_Licence" class="menuButton" onmouseenter="prepareMenu('menu_Licence')" onmousedown="event.preventDefault()" > <span>Overview</span> </div> <div class="off" onmouseleave="leaveMenu('menu_Licence',this)"> <div class="toctree-smilei"> <ul> <li > <a href="#">Licence</a> </li> <li class="outer"> <a href="synopsis.html">Synopsis</a> </li> <li class="outer"> <a href="highlights.html">Highlights</a> </li> <li class="outer"> <a href="releases.html">Releases</a> </li> </ul> </div> </div> </div> <div class="menu" id="menu_Units"> <div id="menuButton_Units" class="menuButton" onmouseenter="prepareMenu('menu_Units')" onmousedown="event.preventDefault()" > <span>Understand</span> </div> <div class="off" onmouseleave="leaveMenu('menu_Units',this)"> <div class="toctree-smilei"> <ul> <li class="outer"> <a href="units.html">Units</a> </li> <li class="outer"> <a href="algorithms.html">PIC algorithms</a> </li> <li class="outer"> <a href="parallelization.html">Parallelization basics</a> </li> <li class="outer"> <a href="vectorization.html">Vectorization</a> </li> <li class="outer"> <a href="collisions.html">Binary collisions</a> </li> <li class="outer"> <a href="ionization.html">Ionization</a> </li> <li class="outer"> <a href="radiation_loss.html">Synchrotron-like radiation reaction</a> </li> <li class="outer"> <a href="multiphoton_Breit_Wheeler.html">Multiphoton Breit-Wheeler pair creation</a> </li> <li class="outer"> <a href="laser_envelope.html">Laser envelope model</a> </li> <li class="outer"> <a href="relativistic_fields_initialization.html">Field initialization for relativistic species</a> </li> </ul> </div> </div> </div> <div class="menu" id="menu_Install"> <div id="menuButton_Install" class="menuButton" onmouseenter="prepareMenu('menu_Install')" onmousedown="event.preventDefault()" > <span>Use</span> </div> <div class="off" onmouseleave="leaveMenu('menu_Install',this)"> <div class="toctree-smilei"> <ul> <li class="outer"> <a href="installation.html">Install</a> </li> <li class="outer"> <a href="namelist.html">Write a namelist</a> </li> <li class="outer"> <a href="run.html">Run</a> </li> <li class="outer"> <a href="post-processing.html">Post-process</a> </li> <li class="outer"> <a href="contribute.html">Contribute</a> </li> </ul> </div> </div> </div> <div class="menu" id="menu_Publications"> <div id="menuButton_Publications" class="menuButton" onmouseenter="prepareMenu('menu_Publications')" onmousedown="event.preventDefault()" > <span>More</span> </div> <div class="off" onmouseleave="leaveMenu('menu_Publications',this)"> <div class="toctree-smilei"> <ul> <li class="outer"> <a href="material.html">Publications</a> </li> <li class="outer"> <a href="partners.html">Partners</a> </li> <li class="outer"> <a href="https://smileipic.github.io/tutorials">Smilei tutorials</a> </li> </ul> </div> </div> </div> <script type="text/javascript"> var es=document.getElementsByClassName("menuButton"), i=0; var evt = "ontouchend" in document ? "touchend" : "click"; for( var i=0; i<es.length; i+=1 ) { es[i].addEventListener(evt, function(a){ return function(){toggleMenu(a)};}(es[i].parentNode.id)); } </script> <div id="searchbox" role="search" style="display:none"> <form class="search" action="search.html" method="get"> <input type="text" name="q" placeholder="Search" id="searchinput" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <div id="searchicon" onclick="openSearch()" style="display:block"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 80 120"> <g transform="translate(0,-932.36216)" > <circle r="25" cy="977.51044" cx="38.078663" style="opacity:1;fill:none;stroke:#ffffff;stroke-width:10;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> <rect transform="matrix(0.36717877,0.93015039,-0.93427297,0.35655858,0,0)" rx="4.9996676" ry="7.4995141" y="316.16959" x="947.6142" height="14.117695" width="46.476151" style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;" /> <path d="m 41.383282,962.25996 a 15,15 0 0 1 11.660107,11.6355" style="opacity:1;fill:none;stroke:#ffffff;stroke-width:3;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> </g> </svg> </div> <div id="closesearchicon" onclick="closeSearch()" style="display:none"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 80 120"> <g transform="translate(0,-932.36216)"> <path d="m 10,962.36216 60,60.00004" style="fill:none;stroke:#ffffff;stroke-width:10;stroke-linecap:round;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none" /> <path d="M 70,962.36216 10,1022.3622" style="fill:none;stroke:#ffffff;stroke-width:10;stroke-linecap:round;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none" /> </g> </svg> </div> <div id="smallScreenMenuButton" onclick="toggleSmallScreenMenu(event)"> <svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" viewBox="-20 -20 140 140"> <g style="fill:#ffffff;stroke:none;"> <circle cx="15" cy="20" r="5" /> <circle cx="35" cy="20" r="5" /> <circle cx="85" cy="20" r="5" /> <rect width="50" height="10" x="35" y="15" rx="0" ry="0" /> <circle cx="15" cy="40" r="5" /> <circle cx="35" cy="40" r="5" /> <circle cx="85" cy="40" r="5" /> <rect width="50" height="10" x="35" y="35" rx="0" ry="0" /> <circle cx="15" cy="60" r="5" /> <circle cx="35" cy="60" r="5" /> <circle cx="85" cy="60" r="5" /> <rect width="50" height="10" x="35" y="55" rx="0" ry="0" /> <circle cx="15" cy="80" r="5" /> <circle cx="35" cy="80" r="5" /> <circle cx="85" cy="80" r="5" /> <rect width="50" height="10" x="35" y="75" rx="0" ry="0" /> </g> </svg> </div> </div> </div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="synopsis.html" title="Synopsis" accesskey="N">next</a> |</li> <li class="right" > <a href="index.html" title="<no title>" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">Smilei v4.1-163-g011c2ce8 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="licence"> <h1>Licence<a class="headerlink" href="#licence" title="Permalink to this headline">¶</a></h1> <p><strong class="program">Smilei</strong> is protected by a <strong>licence CeCILL</strong>, the french equivalent to the open-source Gnu GPL license.</p> <p>Extract:</p> <blockquote> <div><em>This software is governed by the CeCILL-B license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-B license as circulated by CEA, CNRS and INRIA at the following URL</em> <a class="reference external" href="http://www.cecill.info">http://www.cecill.info</a>.</div></blockquote> <p>You can also find more information about the licence in the downloadable tarball of the <a class="reference internal" href="releases.html#latestversion"><span class="std std-ref">latest version of the code</span></a>.</p> <hr class="docutils" /> <div class="section" id="how-to-cite-smilei"> <span id="howtocite"></span><h2>How to cite Smilei<a class="headerlink" href="#how-to-cite-smilei" title="Permalink to this headline">¶</a></h2> <p>Smilei’s development depends on its visibility from publications or presentations featuring its results. When publishing simulation results involving Smilei, <strong>please cite the following article</strong>:</p> <blockquote> <div>J. Derouillat, A. Beck, F. Pérez, T. Vinci, M. Chiaramello, A. Grassi, M. Flé, G. Bouchard, I. Plotnikov, N. Aunai, J. Dargent, C. Riconda, M. Grech, <cite>SMILEI: a collaborative, open-source, multi-purpose particle-in-cell code for plasma simulation</cite>, <a class="reference external" href="https://doi.org/10.1016/j.cpc.2017.09.024">Comput. Phys. Commun. 222, 351-373 (2018)</a>,</div></blockquote> <p>If help or changes in the code were obtained from Smilei developers, please acknowledge their participation in any subsequent publication or presentation.</p> <p>If your publication makes significant use of Smilei, we will gladly list it in the <a class="reference internal" href="material.html"><span class="doc">Publications</span></a>.</p> </div> </div> </div></div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="synopsis.html" title="Synopsis" >next</a> |</li> <li class="right" > <a href="index.html" title="<no title>" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">Smilei v4.1-163-g011c2ce8 documentation</a> »</li> </ul> </div> <div class="footer"> <div> <a href="site.html">Site index</a> </div> <div> Last updated on Jan 31, 2019 </div> <div> Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.3</a> </div> </div> <script type="text/javascript"> var nav = document.getElementById("nav"); var nav_list = document.getElementById("nav_list"); var nav_button = document.getElementById("nav_button"); var smallScreenMenu = document.getElementById("smallScreenMenu"); var smallScreenMenuButton = document.getElementById("smallScreenMenuButton"); var searchicon = document.getElementById("searchicon"); var searchbox = document.getElementById("searchbox"); var searchinput= document.getElementById("searchinput"); var menus = document.getElementsByClassName("menu"); for( var i=0; i<menus.length; i++ ) menus[i].active = false; var ul = nav_list.getElementsByTagName("ul")[0], li; var keep_nav = false; if( ul ) { li = ul.firstElementChild; if( li ) { if( li.getElementsByTagName("ul").length > 0 ) keep_nav = true; } } if( keep_nav ) { li.removeChild( li.firstElementChild ); } else { document.getElementById("nav_positioner").removeChild( document.getElementById("nav") ); } function navOff() { nav_list.style.display = "none"; nav_button.className = ""; nav.style.overflowY = "visible"; } function toggleNav() { for( var i=0; i<menus.length; i++ ) menuOff( menus[i] ); if( nav_list.style.display != "inline-block" ) { nav_list.style.display = "inline-block"; nav_button.className = "pushed"; nav.style.overflowY = "auto"; } else { navOff(); } } function toggleSmallScreenMenu(e) { e.preventDefault(); if( smallScreenMenu.className != "on" ) { smallScreenMenu.className = "on"; smallScreenMenuButton.className = "pushed"; } else { smallScreenMenu.className = "off"; smallScreenMenuButton.className = ""; } } function prepareMenu(menu_id) { var menu = document.getElementById(menu_id); menu.timer1 = setTimeout(function(a){ return function(){thisMenuOnly(a)};}(menu_id), 100); menu.addEventListener("mouseleave", function(a){ return function(){clearTimeout(a.timer1)};}(menu) ); } function leaveMenu(menu_id, source) { var menu = document.getElementById(menu_id); menu.timer2 = setTimeout(function(a){ return function(){menuOff(a)};}(menu), 1000); source.addEventListener("mouseenter", function(a){ return function(){clearTimeout(a.timer2)};}(menu) ); } function menuOn( menu ) { var divs = menu.getElementsByTagName("div"); if(nav_list) navOff(); divs[1].className = "on"; divs[0].className = "menuButton pushed"; menu.active = true; } function menuOff( menu ) { var divs = menu.getElementsByTagName("div"); divs[1].className = "off"; divs[0].className = "menuButton"; menu.active = false; } function thisMenuOnly(menu_id) { var menu = document.getElementById(menu_id); for( var i=0; i<menus.length; i++ ) if( i!=menu_id ) menuOff( menus[i] ); menuOn( menu ); } function toggleMenu(menu_id) { var menu = document.getElementById(menu_id); if( menu.active ) { menuOff( menu ); } else { for( var i=0; i<menus.length; i++ ) if( i!=menu_id ) menuOff( menus[i] ); menuOn( menu ); } } function openSearch() { for( var i=0; i<menus.length; i++ ) { menuOff( menus[i] ); menus[i].style.zIndex = "-1"; } searchicon.style.display = "none"; closesearchicon.style.display = "block"; searchbox.style.display = "block"; searchinput.focus(); } function closeSearch() { searchicon.style.display = "block"; closesearchicon.style.display = "none"; searchbox .style.display = "none"; for( var i=0; i<menus.length; i++ ) menus[i].style.zIndex = "0"; } var documentDiv = document.getElementsByClassName("document")[0]; documentDiv.addEventListener('click', function (event) { if(nav_list) navOff(); for( var i=0; i<menus.length; i++ ) menuOff( menus[i] ); }); </script> </body> </html>
About
a collaborative, open-source, multi-purpose particle-in-cell code for plasma simulation
Stars
Watchers
Forks
Packages 0
No packages published
Languages
- C++ 82.4%
- Python 17.0%
- Other 0.6%