Difference between revisions of "Yade"

From Yade

 
(76 intermediate revisions by 10 users not shown)
Line 1: Line 1:
  +
<span style="font-size:140%">'''This is Yades's wiki, mostly outdated, check the project's [http://yade-dem.org HOMEPAGE] '''</span>
  +
 
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.
   
 
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].'''
'''Detailed reference documentation and theoretical background are [https://www.yade-dem.org/sphinx/ here].'''
 
   
  +
* '''[https://gitlab.com/yade-dev/trunk Source code on gitlab]
'''Source code and development website (bugs, blueprints, mailing lists) are hosted at [http://www.launchpad.net/yade/ launchpad].'''
 
   
  +
* '''[http://www.launchpad.net/yade/ development website → launchpad] (bugs tracking, mailing lists, blueprints).'''
'''This wiki is a general introduction and overview of Yade and its features. It also gives a quick tour of installation and usage (less detailed than in reference documentation).'''
 
  +
  +
  +
__NOTOC__
  +
----
  +
  +
= [https://2ndyadeworkshop.sciencesconf.org/ Second Yade Workshop, Aix-en-Provence April 2018] =
  +
  +
  +
  +
----
  +
  +
= [[1st_Yade_Workshop |Announcement for the first Yade Workshop, Grenoble July 2014]] =
  +
  +
  +
  +
----
   
 
= Yade Community =
 
= Yade Community =
  +
* [https://launchpad.net/yade/+announcements NEWS]
* [[Contact | Contact]]
 
  +
* [[Authors_and_contributors | Authors and contributors]]
* [[Publications | Publications]] (sphinx link?)
 
  +
* [https://yade-dem.org/doc/citing.html Citing Yade in publications]
* [[WhoIsDoingWhat | Who Is Doing What]]
 
  +
* [https://yade-dem.org/doc/user.html#getting-help Contact]
* [[Authors_and_contributors | Authors and contributors]] (sphinx link?)
 
  +
* [https://www.yade-dem.org/doc/publications.html Publications]
* [[Yade_history | Yade history]] (sphinx link?)
 
* [https://blueprints.launchpad.net/yade Future plans]
 
 
* [[We_need_your_help | We need your help!]]
 
* [[We_need_your_help | We need your help!]]
  +
   
 
=Overview=
 
=Overview=
   
 
== Examples ==
 
== Examples ==
* [https://www.yade-dem.org/wiki/Category:Screenshots Simulation examples]
 
 
* [[Screenshots_and_videos | Screenshots and videos]]
 
* [[Screenshots_and_videos | Screenshots and videos]]
   
 
== Features ==
 
== Features ==
 
* [[ConstitutiveLaws | Constitutive Laws]] (sphinx link?)
 
* [[ConstitutiveLaws | Constitutive Laws]] (sphinx link?)
* [[Lattice_Geometrical_Model | Lattice Geometrical Model]]
 
 
* [[TriaxialTest | Triaxial Test]]
 
* [[TriaxialTest | Triaxial Test]]
 
* [[CapillaryTriaxialTest | Capillary forces in unsaturated materials]]
 
* [[CapillaryTriaxialTest | Capillary forces in unsaturated materials]]
 
* [[Triangulation | Triangulation]]
 
* [[Triangulation | Triangulation]]
* [[Mgpost | Using Mgpost]]
 
* Present more developments here...
 
   
 
==F.A.Q.==
 
==F.A.Q.==
Line 37: Line 51:
   
 
= Installation =
 
= Installation =
  +
* [https://yade-dem.org/doc/installation.html Installation instructions]
** [[Installation_of_yade_on_debian_or_kubuntu | YADE installation on Debian, Ubuntu/Kubuntu]]
 
   
 
=Development=
 
=Development=
   
 
'''Version handling'''
 
'''Version handling'''
* [[Quick_Bazaar_tutorial | Quick Bazaar tutorial]]
+
* [https://yade-dem.org/doc/gitlab.html Quick tutorial for Git/GitLab]
 
* [[Tracking_changes_using_kompare | Tracking changes using kompare]]
 
* [[Tracking_changes_using_kompare | Tracking changes using kompare]]
   
 
'''Information on source code'''
 
'''Information on source code'''
  +
* [[Using_kdevelop4 | Using Kdevelop4]]
* [[Adding_plugin_to_the_source_tree | Adding plugin to the source tree]]
 
* [[Third_party_plugins | How to add third party plugins]]
 
* [[ImplicitBuilds | Implicit Builds]]
 
* [[DebianPackages | How to build Debian Packages]]
 
   
 
'''Debugging'''
 
'''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_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]]
 
 
* [[Colliders_performace | Colliders performace]]
 
 
= Other=
 
* [[Logo | Logo ]]
 
* [[Sandbox | Help for editing this Wiki]]
 
 
'''Draft pages'''
 
* [[Snow_documentation| Creep in polyhedral grains packings (snow model)]]
 
 
= REPLACE WITH SPHINX LINKS =
 
Links needed in wiki main page. They still display the wiki pages but might point to equivalent sphinx pages (some are listed above and duplicated here).
 
* [[Publications | Publications]] (convert to bibtex; more useful for paper writers as well)
 
* [[Authors_and_contributors | Authors and contributors]]
 
* [[Yade_history | Yade history]]
 
* [[Python3Intro | Python3Intro]] (and maybe [[PythonPrimer | Python Primer]]?)
 
* [[News | News]]
 
* [[First_steps | First steps. Instruction how to start YADE simple simulation]] (in sphinx)
 
* [[SimpleSceneTutorial | Simple Scene Tutorial]]
 
* [[SimpleSceneCpp | Simple Scene Cpp]]
 
* [[SimpleScenePython | Simple Scene Python]]
 
 
Candidate sphinx pages for replacement are :
 
* ?
 
 
 
= TO REMOVE =
 
* [[SharedMaterialProperties | SharedMaterialProperties]]
 
* [[Release_NEWS | Release NEWS]]
 
* [[ProgrammingRules | Programming Rules]]
 
* [[Reference_documentation | Reference documentation (Doxygen and Epydoc))]]
 
* [[Future_plans | Future plans]] (http://blueprints.launchpad.net/yade)
 
* [[Usage_details| Explanation how to use graphic YADE interface]] (outdated)
 
* [[New:3D_graphics | 3D graphics]] (much better situation now, typically works out of the box)
 
* [[New:Going_further | Going further]] (??)
 
* [[Reported_problems | Reported problems]] (https://bugs.launchpad.net/yade/ for this)
 
* [[Debugging_with_Backtrace | Debugging with Backtrace]]
 
* [[Version_Numbering | Version Numbering]]
 
 
(already in the sphinx docs)
 
* [[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]]
 
** [[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:Making_videos | Making videos]]
 
* [[Installation | Installation. Common information]]
 
** [[Installation_details | Installation details]]
 
** [[New:Required_packages | Required packages]] (outdated and is debian-specific; necessary packages are mentioned at the debian page already)
 
 
Examples and scripts (in sphinx mostly as well, quite outdated anyway)
 
* [[SimpleSceneTutorial | Simple Scene Tutorial]]
 
* [[SimpleSceneCpp | Simple Scene Cpp]]
 
* [[SimpleScenePython | Simple Scene Python]]
 
* [[ScriptGenerateBoxPacking | ScriptGenerateBoxPacking DRAFT]]
 
* [[ScriptGenerateCylindricalPacking | ScriptGenerateCylindricalPacking DRAFT]]
 
* [[ScriptUniaxialTensionCompressionTest | ScriptUniaxialTensionCompressionTest DRAFT]]
 
 
 
= TO UPDATE =
 
* [[Getting_started | Getting started (a Yade beginner experience) (UPDATES)]]
 
* [[ New_to_linux? | New to Linux?]]
 
 
= BLUEPRINTS =
 
(blueprints can be linked to a wiki page, but that page cannot be hosted at launchpad itself (there is no wiki there). Therefore, we must keep those here (for future reference), but they don't have to be linked from anywhere, as their URL is in the blueprint already.
 
 
* [[Insertion_Sort_Collider_Stride | Insertion Sort Collider Stride]]
 
* [[ExamplesCleanup | Examples Cleanup]]
 
* [[Sanitizing_Contact_Logic | Sanitizing Contact Logic]]
 
* [[RegressionsTests | Regressions Tests]]
 
* [[Yade_Wiki_Structure | Yade_Wiki_Structure]]
 
* [[Pages_required_reworking | Pages required reworking]]
 
   
  +
== Removed ==
 
* [[Removed_Pages | Removed Pages]]
 
* [[Removed_Pages | Removed Pages]]

Latest revision as of 16: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