.. _getting_started_dynalib:

Getting started
===============

Overview
--------
The DYNA-Lib project provides Python libraries to build a DYNA keyword
input file and facilities to run the Ansys LS-DYNA solver. With DYNA-Lib,
you can perform these actions:

- Generate, read, and write all keywords*
- Run the LS-DYNA solver

Installation
------------
DYNA-Lib has two installation modes: user and developer.
The following instructions assume that you want to install DYNA-Lib
in user mode. If you want to contribute to the development of DYNA-Lib,
you must install it in developer mode. For more information,
see :ref:`contribute_dynalib`.

#. To ensure that you have the latest version of `pip`_, run this command:

   .. code:: bash

       python -m pip install -U pip

#. To install DYNA-Lib, run this command:

   .. code:: bash

       python -m pip install dynalib

.. LINKS AND REFERENCES
.. _pip: https://pypi.org/project/pip/