{% extends "layout.html" %}
{% set title = 'Overview' %}
{% block body %}
  <h1>Welcome to Yade - Open Source Discrete Element Method</h1>
   <p style="font-weight: bold">
	The Yade project is a strong community based entirely on peaceful international cooperations. This diverse foundation has bound us to many brilliant scientists from Ukraine and Russia who are unjustly affected by the current hostilities perpetrated by Russia on Ukraine.
	We, the Yade developers and users, hope for the immediate cessation of agression followed by the prompt restoration of peace in Ukraine. We stand with the people of Ukraine, the citizens of Russia, and the thousands of Russian scientists who <a href="https://access2perspectives.org/2022/02/an-open-letter-from-russian-scientists-and-science-journalists-against-the-war-with-ukraine/">vehemently protest this war.</a> As these scientists point out, this unlawful invasion puts many innocent lives at risk in both Ukraine and Russia. Without a doubt, we will continue to keep these Ukranians and Russians in our thoughts as we await a peaceful conclusion ahead. 
  </p>  
  <p>
	Yade is an extensible open-source framework for discrete numerical models, focused on the Discrete Element Method. The computation parts are written in c++ using a flexible object model and allowing independent implementation of new algorithms and interfaces. Python is used for rapid and concise scene construction, simulation control, postprocessing and debugging.
  </p>
  Yade is located at <a href="https://yade-dem.org">yade-dem.org</a>, which contains <a href="https://www.yade-dem.org/doc/">this documentation</a> and <a href="https://www.yade-dem.org/wiki/">wiki</a>. Development is kindly hosted on <a href="https://gitlab.com/yade-dev"> GitLab </a>; they are used for <a href="https://gitlab.com/yade-dev/trunk">source code</a> and <a href="https://gitlab.com/yade-dev/trunk/issues">bug tracking</a>. Building, regression tests and packages distribution are hosted on servers of the <a href="http://geomec.net/newsletter/">Grenoble Geomechanics group</a>  at <a href="https://www.3sr-grenoble.fr/spip.php?rubrique1">Laboratoire 3SR</a>, <a href="https://gricad.univ-grenoble-alpes.fr">UMS Gricad</a> and <a href="https://pg.edu.pl/">Gdańsk University of Technology</a>.
  </p>
  <p>
  Yade supports <a href="{{ pathto("HighPrecisionReal") }}#installation"> high precision calculations</a> (following this <a href="https://www.sciencedirect.com/science/article/pii/S0010465521002794">publication</a>) and Python 3 (see <a href="{{ pathto("installation") }}#python-2-backward-compatibility"> backward compatibility</a> for Python 2). The development branch is on <a href="https://gitlab.com/yade-dev/trunk">GitLab</a>.
  </p>
  <p>
   This documentation describes Yade version {{ version }}, see <a href="https://gitlab.com/yade-dev/trunk/-/releases">changelogs</a>. You can also <a href="http://yade-dem.org/doc/Yade.pdf">download a PDF version</a> of this documentation. 
  </p>
  
  <h2>Acknowledging Yade</h2>

<p style="margin-left: 30px">
     Please make sure you read the <a href="{{ pathto("citing") }}">"Acknowledging Yade"</a> section if you plan to use Yade for publications.
</p>

 <h2>Documentation</h2>

  <table class="contentstable" align="center" style="margin-left: 30px">
    <tr>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="{{ pathto("introduction") }}">Introduction</a><br/>
           <span class="linkdescr">getting familiar with Yade</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}">Tutorial</a><br/>
           <span class="linkdescr">first steps with practical <a class="link" href="{{ pathto("tutorial-examples") }}">examples</a></span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("user") }}">User's Manual</a><br/>
           <span class="linkdescr">functionality guide and description</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("prog") }}">Programmer's Manual</a><br/>
           <span class="linkdescr">understanding and modifying the internals of Yade</span></p>
      </td>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="{{ pathto("formulation") }}">DEM Formulation</a><br/>
           <span class="linkdescr">the Discrete Element Method (DEM)</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("yade.wrapper") }}">Class reference</a><br/>
           <span class="linkdescr">simulation building blocks, c++ &amp; python</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("modules") }}">Yade modules</a><br/>
           <span class="linkdescr">python modules extending Yade</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("FEMxDEM") }}">Multiscale FEMxDEM</a><br/>
           <span class="linkdescr">Parallel coupling using Escript and Yade</span></p>
      </td>
    </tr>
    <tr>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="{{ pathto("references") }}">References</a><br/>
           <span class="linkdescr">articles cited in the documentation</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("installation") }}">Installation</a><br/>
           <span class="linkdescr">from binaries and sources</span></p>
       <p class="biglink"><a class="biglink" href="{{ pathto("index-toctree") }}">Full contents</a><br/>
           <span class="linkdescr">with all the details</span></p>
      </td>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">Index</a><br/>
           <span class="linkdescr">all functions, classes, attributes</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search</a><br/>
           <span class="linkdescr">search the documentation</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("yadeTechArchive") }}">Yade Technical Archive</a><br/>
           <span class="linkdescr">documents written by and for the Yade community</span></p>
      </td>
    </tr>
  </table>

 <h2>Yade Community</h2>
 
 <table class="contentstable" align="center" style="margin-left: 30px">
    <tr>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="https://yade-dem.org/wiki/Authors_and_contributors">Authors and contributors</a><br/>
           <span class="linkdescr">information about the people working on Yade</span></p>
        <p class="biglink"><a class="biglink" href="https://yade-dem.org/doc/user.html#getting-in-touch-with-yade-community">Public support and Discussions</a><br/>
           <span class="linkdescr">Getting help, getting in touch</span></p>
        <p class="biglink"><a class="biglink" href="https://www.yade-dem.org/doc/publications.html">Publications</a><br/>
           <span class="linkdescr">on Yade itself or done with Yade</span></p>
        <p class="biglink"><a class="biglink" href="https://yade-dem.org/doc/tutorial-more-examples.html">Screenshots and videos</a><br/>
          <span class="linkdescr">Simulation examples; feel free to add yours.</span></p>
      </td>
      <td width="50%">
        <p class="biglink"><a class="biglink" href="https://discord.gg/rku35YXZJd">Discord server</a><br/>
           <span class="linkdescr">A place to meet, chat, and collaborate</span></p>
        <p class="biglink"><a class="biglink" href="https://twitter.com/YadeDEM">Twitter account</a><br/>
           <span class="linkdescr">Follow Yade news and interact with us</span></p>
        <p class="biglink"><a class="biglink" href={{ pathto("consulting") }}>Paid support and Consulting</a><br/>
           <span class="linkdescr">Need professional help?</span></p>
        <p class="biglink"><a class="biglink" href="{{ pathto("events") }}">Yade community events</a><br/>
            <span class="linkdescr">community events</span></p>
      </td>
    </tr>
 </table>
 
<!--
  <p>
    You can also download PDF versions of the Sphinx documentation:
    a <a href="http://sphinx.pocoo.org/sphinx.pdf">version</a> generated from
    the LaTeX Sphinx produces, and
    a <a href="http://sphinx.pocoo.org/sphinx-rst2pdf.pdf">version</a> generated
    by rst2pdf.
  </p>

  <h2>Examples</h2>
  <p>Links to documentation generated with Sphinx can be found on the
    <a href="{{ pathto("examples") }}">Projects using Sphinx</a> page.
  </p>
  <p>
    For examples of how Sphinx source files look, use the &#8220;Show
    source&#8221; links on all pages of the documentation apart from this
    welcome page.
  </p>

  <p>You may also be interested in the very nice
    <a href="http://matplotlib.sourceforge.net/sampledoc/">tutorial</a> on how to
    create a customized documentation using Sphinx written by the matplotlib
    developers.</p>

  <p>There is a <a href="http://sphinx-users.jp/doc10/">Japanese translation</a>
    of this documentation, thanks to Yoshiki Shibukawa.</p>

  <h2>Get Sphinx</h2>
  <p>
    Sphinx is available as an <a
    href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy-install</a>able
    package on the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
    Index</a>.
  </p>
  <p>The code can be found in a Mercurial repository, at
    <tt>http://bitbucket.org/birkenfeld/sphinx/</tt>.</p>
-->

{% endblock %}
