Difference between revisions of "Yade"

From Yade

 
(107 intermediate revisions by 11 users not shown)
Line 1: Line 1:
'''(This wiki is for documentation; the project has also [http://www.launchpad.net/yade/ pages at launchpad])'''
+
<span style="font-size:140%">'''This is Yades's wiki, mostly outdated, check the project's [http://yade-dem.org HOMEPAGE] '''</span>
 
'''Main documentation is [https://www.yade-dem.org/sphinx/ here]'''
 
   
 
Yade is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The project started as an offspring from SDEC at Grenoble University, now is being developed at multiple research institutes and has active and helpful user community.
 
Yade is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The project started as an offspring from SDEC at Grenoble University, now is being developed at multiple research institutes and has active and helpful user community.
Line 7: Line 5:
 
The computation parts are written in c++ using flexible object model, allowing independent implementation of new alogrithms, interfaces with other software packages (e.g. flow simulation), data import/export routines. Python can be used to create and manipulate the simulation or for postprocessing.
 
The computation parts are written in c++ using flexible object model, allowing independent implementation of new alogrithms, interfaces with other software packages (e.g. flow simulation), data import/export routines. Python can be used to create and manipulate the simulation or for postprocessing.
   
  +
* '''[https://yade-dem.org/doc/ Yade manuals, reference documentation and theoretical background].'''
<!--
 
{| style="margin:0;padding:0ex;width:100%;"
 
|valign="top" style="width:17em" |
 
<strong>
 
* [[News|News about yade]]
 
* [[Publications|List of publications]]
 
* [[Reference documentation|Reference documentation]]
 
* [[Screenshots and videos|Screenshots and videos]]
 
* [[Installation|Download yade]]
 
* [[Getting started]]
 
</strong>
 
|valign="top" style="text-align: justify;" |
 
   
  +
* '''[https://gitlab.com/yade-dev/trunk Source code on gitlab]
__NOTOC__[[Image:Yade135_less_red.png|right]]
 
Open source discrete modelling, finite element method, all in one!
 
   
  +
* '''[http://www.launchpad.net/yade/ development website → launchpad] (bugs tracking, mailing lists, blueprints).'''
YADE Open-Dem is an Open Source GNU/GPL Software framework designed with dynamic libraries in a way that it is easy to add new numerical models for simulation. It aims to provide versatile means to perform discrete modelling.
 
   
|}
 
   
  +
__NOTOC__
{| style="margin:0;padding:0;width:100%;"
 
  +
----
|valign="top" style="width:67%;text-align: justify;" |
 
   
  +
= [https://2ndyadeworkshop.sciencesconf.org/ Second Yade Workshop, Aix-en-Provence April 2018] =
==Abstract==
 
|valign="top" style="width:3%" |
 
&nbsp;
 
   
|valign="top" style="width:30%" |
 
==Browse yade==
 
<div style="font-size: 95%;color: #666;">Press '''+''' to expand</div>
 
<categorytree mode=all>Yade</categorytree>
 
|}
 
   
==Some pictures==
 
   
  +
----
<div style="font-size: 95%;color: #666;">Upload here cool screenshots</div>
 
   
  +
= [[1st_Yade_Workshop |Announcement for the first Yade Workshop, Grenoble July 2014]] =
[[Image:Yade256.png|150px]]
 
   
== Recent Additions ==
 
COMMENT -- DPL manual: http://semeb.com/dpldemo --
 
   
'''[[Documentation]]'''
 
<dpl>
 
categoryregexp=.*documentation
 
ordermethod=firstedit
 
order=descending
 
count=5
 
mode=userformat
 
listseparators=,* %DATE% [[%TITLE%]]\n,,
 
addeditdate=true
 
userdateformat=d m Y:
 
</dpl>
 
'''[[Publications]]'''
 
<dpl>
 
categoryregexp=Publication
 
ordermethod=firstedit
 
order=descending
 
count=5
 
mode=userformat
 
listseparators=,* %DATE% [[%TITLE%]]\n,,
 
addeditdate=true
 
userdateformat=d m Y:
 
</dpl>
 
'''[[Patches]] ?????'''
 
<dpl>
 
categoryregexp=patches
 
notnamespace=Template
 
ordermethod=firstedit
 
order=descending
 
count=5
 
mode=userformat
 
listseparators=,* %DATE% [[%TITLE%]]\n,,
 
addeditdate=true
 
userdateformat=d m Y:
 
</dpl>
 
   
  +
----
'''[[Engines]] ?????'''
 
<dpl>
 
categoryregexp=Engine
 
notnamespace=Template
 
ordermethod=firstedit
 
order=descending
 
count=5
 
mode=userformat
 
listseparators=,* %DATE% [[%TITLE%]]\n,,
 
addeditdate=true
 
userdateformat=d m Y:
 
</dpl>
 
   
  +
= Yade Community =
==Pros and cons==
 
  +
* [https://launchpad.net/yade/+announcements NEWS]
  +
* [[Authors_and_contributors | Authors and contributors]]
  +
* [https://yade-dem.org/doc/citing.html Citing Yade in publications]
  +
* [https://yade-dem.org/doc/user.html#getting-help Contact]
  +
* [https://www.yade-dem.org/doc/publications.html Publications]
  +
* [[We_need_your_help | We need your help!]]
   
{| style="margin:0;padding:0.2em;width:100%;"
 
|valign="top" style="width:49%;text-align: justify;" |
 
''Advantages:''
 
* allows numerous simulation methods in the single framework, so coupling them becomes possible,
 
* plugins can import data from other software,
 
* thoughtful code design promotes code reuse and improvement,
 
* open source development model allows community feedback.
 
   
  +
=Overview=
|valign="top" style="width:2%" |
 
&nbsp;
 
|valign="top" style="width:49%;text-align: justify;" |
 
   
  +
== Examples ==
''Disadvantages:''
 
* implementing models requires adhering to framework design,
 
* Yade framework is a new emerging software, still in beta phase
 
* Documentation is lacking, although switching to wiki should help a lot now.
 
* if you know more disadvantages, let [[Contact|us]] know!
 
 
|}
 
 
==Release status==
 
 
{| style="margin:0;padding:0.2em;width:100%;"
 
 
|valign="top" style="width:19%" |
 
* release
 
* version&nbsp;number
 
* operating&nbsp;systems
 
|valign="top" style="width:1%" |
 
&nbsp;
 
|valign="top" style="width:80%" |
 
&nbsp;: beta<br>
 
&nbsp;: 0.12.1<br>
 
&nbsp;: linux<br>
 
|}
 
 
-->
 
 
==First to read==
 
===Common information ===
 
* [[First_steps | First steps. Instruction how to start YADE simple simulation]]
 
* [[Getting_started | Getting started]]
 
* [[FAQ | Frequently asked questions (FAQ) on YADE]]
 
* [https://yade.hmg.inpg.fr/index.php/Category:Screenshots Screenshots]
 
 
* [[Screenshots_and_videos | Screenshots and videos]]
 
* [[Screenshots_and_videos | Screenshots and videos]]
   
=== Installation ===
+
== Features ==
  +
* [[ConstitutiveLaws | Constitutive Laws]] (sphinx link?)
* [[Installation | Installation. Common information]]
 
  +
* [[TriaxialTest | Triaxial Test]]
** [[Installation_details | Installation details]]
 
  +
* [[CapillaryTriaxialTest | Capillary forces in unsaturated materials]]
** [[Installation_of_yade_on_debian_or_kubuntu | YADE installation on Debian, Kubuntu/Ubuntu]]
 
  +
* [[Triangulation | Triangulation]]
** [[Installation_of_yade_on_fedora | YADE installation on Fedora/RedHat]]
 
** [[Installation_of_yade_on_gentoo | YADE installation on Gentoo]]
 
** [[Installation_of_yade_on_MacOSX_Leopard | YADE installation on Mac OS X]]
 
** [[New:Required_packages | Required packages]]
 
** [[Reported_problems | Reported problems]]
 
   
  +
==F.A.Q.==
=== New to Linux? ===
 
  +
* [[FAQ | Frequently asked questions on YADE]]
* [[ New_to_linux? | New to Linux?]]
 
** [[New:3D_graphics | 3D graphics]]
 
** [[New:Going_further | Going further]]
 
** [[New:Porting_QGLViewer_to_kubuntu | Porting QGLViewer to Kubuntu]]
 
=== Physics===
 
* [[How_it_works | Simple DEM explanation]]
 
* [[Discrete_Element_Method | Discrete Element Method]]
 
* [[Lattice_Geometrical_Model | Lattice Geometrical Model]]
 
   
  +
= Installation =
== Yade Community ==
 
  +
* [https://yade-dem.org/doc/installation.html Installation instructions]
* [[Publications | Publications]]
 
* [[Contact | Contact]]
 
* [[News | News]]
 
* [[Release_NEWS | Release NEWS]]
 
* [[Authors_and_contributors | Authors and contributors]]
 
* [[WhoIsDoingWhat | Who Is Doing What]]
 
* [[Yade_history | Yade history]]
 
* [[Future_plans | Future plans]]
 
   
  +
=Development=
==Using YADE==
 
* [[Usage_details| Explanation how to use graphic YADE interface]]
 
* [[New:Making_videos | Making videos]]
 
* [[Mgpost | Using Mgpost]]
 
==Development==
 
* [[Coding | Coding]]
 
* [[Quick_Bazaar_tutorial | Quick Bazaar tutorial]]
 
* [[Quick_subversion_tutorial | Quick subversion tutorial]]
 
* [[Reference_documentation | Reference documentation (Doxygen and Epydoc))]]
 
* [[Development_schedule | Development schedule]]
 
* [[Development_Summary | Development Summary]]
 
* [[Version_Numbering | Version Numbering]]
 
* [[Schedule | Schedule]]
 
   
  +
'''Version handling'''
=== Information on source code ===
 
  +
* [https://yade-dem.org/doc/gitlab.html Quick tutorial for Git/GitLab]
* [[Adding_plugin_to_the_source_tree | Adding plugin to the source tree]]
 
  +
* [[Tracking_changes_using_kompare | Tracking changes using kompare]]
* [[Third_party_plugins | How to add third party plugins]]
 
* [[ConstitutiveLawHowto | Constitutive Law Howto]]
 
* [[ConstitutiveLaws | Constitutive Laws]]
 
* [[Contacts_overview | Contacts overview]]
 
* [[RegressionsTests | Regressions Tests]]
 
* [[Triangulation | Triangulation]]
 
* [[TriaxialTest | Triaxial Test]]
 
* [[CapillaryTriaxialTest | Capillary Triaxial Test]]
 
* [[ProgrammingRules | Programming Rules]]
 
   
  +
'''Information on source code'''
=== Examples ===
 
* [[SimpleSceneTutorial | Simple Scene Tutorial]]
+
* [[Using_kdevelop4 | Using Kdevelop4]]
* [[SimpleSceneCpp | Simple Scene Cpp]]
 
* [[SimpleScenePython | Simple Scene Python]]
 
   
  +
'''Debugging'''
==== Python ====
 
* [[Python3Intro | Python3Intro]]
 
* [[PythonPrimer | Python Primer]]
 
* [[PythonPlotting | Creating simple plots with python]]
 
* [[ScriptParametricStudy | Script Parametric Study. Explains how to use yade-$version-multi scripts]]
 
* [[ScriptPlotContactDirectionDistribution | Script Plot Contact Direction Distribution]]
 
 
=== Articles about development and debugging ===
 
* [[ImplicitBuilds | Implicit Builds]]
 
* [[DebianPackages | How to build Debian Packages]]
 
 
====Debugging ====
 
 
* [[Introduction_to_debugging | Introduction to debugging]]
 
* [[Introduction_to_debugging | Introduction to debugging]]
 
* [[Debugging_using_Kdevelop | Debugging using Kdevelop]]
 
* [[Debugging_using_Kdevelop | Debugging using Kdevelop]]
* [[Debugging_using_Valgrind | Debugging using Valgrind]]
 
* [[Debugging_with_Backtrace | Debugging with Backtrace]]
 
* [[Debugging_and_speed_profiling | Debugging and speed profiling]]
 
 
* [[Speed_profiling_using_KCachegrind | Speed profiling using KCachegrind]]
 
* [[Speed_profiling_using_KCachegrind | Speed profiling using KCachegrind]]
 
* [[Speed_profiling_using_TimingInfo_and_TimingDeltas_classes | Speed profiling using TimingInfo and TimingDeltas classes]]
 
* [[Speed_profiling_using_TimingInfo_and_TimingDeltas_classes | Speed profiling using TimingInfo and TimingDeltas classes]]
   
=== Performance and optimization ===
+
'''Performance and optimization'''
  +
* [[Comparisons_with_PFC3D | Comparisons with PFC3D™]]
* [[Performance_Tuning | Performance Tuning]]
 
  +
* [[Colliders_performace | Colliders performance]]
* [[Triaxial_Test_Parallel | Triaxial Test Parallel]]
 
  +
* [[Performance_Test | Performance Testing (yade --performance)]]
* [[Benchmark_revision1253 | Benchmark revision1253]]
 
* [[Benchmarks | Benchmarks]]
 
* [[Insertion_Sort_Collider_Stride | Insertion Sort Collider Stride]]
 
* [[Colliders_performace | Colliders performace]]
 
 
=== Drafts ===
 
 
* [[ExamplesCleanup | Examples Cleanup]]
 
* [[Sanitizing_Contact_Logic | Sanitizing Contact Logic]]
 
* [[ScriptGenerateBoxPacking | ScriptGenerateBoxPacking]]
 
* [[ScriptGenerateCylindricalPacking | ScriptGenerateCylindricalPacking]]
 
* [[ScriptUniaxialTensionCompressionTest | ScriptUniaxialTensionCompressionTest]]
 
* [[SharedMaterialProperties | SharedMaterialProperties]]
 
* [[Yade_Wiki_Structure | Yade_Wiki_Structure]]
 
* [[Pages_required_reworking | Pages required reworking]]
 
* [[Snow_documentation| Snow documentation]]
 
   
== Other==
+
== Removed ==
* [[Logo | Logo ]]
+
* [[Removed_Pages | Removed Pages]]
* [[Sandbox | Sandbox]]
 
[[Category:Overview]]
 
[[Category:New documentation structure and items]]
 

Latest revision as of 15:19, 20 May 2021

This is Yades's wiki, mostly outdated, check the project's HOMEPAGE

Yade is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The project started as an offspring from SDEC at Grenoble University, now is being developed at multiple research institutes and has active and helpful user community.

The computation parts are written in c++ using flexible object model, allowing independent implementation of new alogrithms, interfaces with other software packages (e.g. flow simulation), data import/export routines. Python can be used to create and manipulate the simulation or for postprocessing.



Second Yade Workshop, Aix-en-Provence April 2018


Announcement for the first Yade Workshop, Grenoble July 2014


Yade Community


Overview

Examples

Features

F.A.Q.

Installation

Development

Version handling

Information on source code

Debugging

Performance and optimization

Removed