{% extends "parent/layout.htm" %} {% block page_title %} Download - {{ super()
}} {% endblock %} {% block hero_title %}Download{% endblock %} {% block
gui_content %}
<p>
  The PSDI Data Conversion service can be downloaded for local use. This is recommended when you wish to convert
  sensitive files or files exceeding the size limit for the public service, or to access it via the command-line or
  Python library, which include some additional features such as support for chained conversions.
</p>

<h2>Installation</h2>

<h3>Install via pip</h3>

<ul>
  <li>
    <a href="https://pypi.org/project/psdi-data-conversion/">PSDI Data Conversion Service on PyPI</a>
  </li>
</ul>

<p>
  The easiest way to install the project is via Python’s pip utility. If you do
  not already have this installed, the readme in the link above provides details
  on installing Python and pip. If you do, you can install the package via:
</p>

<pre><code class="secondary">pip install 'psdi-data-conversion[gui]'</code></pre>

<p>
  The <code class="secondary">[gui]</code> portion installs the optional
  requirements needed to run a local version of this webpage, and can be
  excluded if you only intend to use the command-line interface and/or Python
  library.
</p>

<h3>Source Code</h3>

<ul>
  <li>
    <a href="https://github.com/PSDI-UK/psdi-data-conversion">PSDI Data Conversion Project on GitHub</a>
  </li>
</ul>

The project’s source code is available on GitHub at the link above. If you wish to install it from source, you can clone
the repository and then install it via:

<pre><code class="secondary">pip install '.[gui-test]'</code></pre>

<p>
  The <code class="secondary">[gui-test]</code> portion installs all optional
  components for running the local webpage and testing all project components.
  See the project’s <code class="secondary">pyproject.toml</code> file for other
  possible optional dependency sets that can be installed.
</p>

<h2>Use</h2>

<p>Once installed, the project can be used in one of three ways:</p>

<ul>
  <li>
    <strong>Local Gui:</strong> Run the script
    <code class="secondary">psdi-data-convert-gui</code> to start the server.
    Append the <code class="secondary">--help</code> option for to see optional
    arguments (most of which are only used for development purposes)
  </li>
  <li>
    <strong>Command-Line Interface:</strong> Run the script
    <code class="secondary">psdi-data-convert</code> to use the application at
    the command-line. Append the <code class="secondary">--help</code> option to
    see arguments for it, and/or find documentation in the project’s README.
  </li>
  <li>
    <strong>Python Library:</strong> Within a Python script, library, or
    terminal, the project can be imported via
    <code class="secondary">import psdi_data_conversion</code>, with the most
    useful function being
    <code class="secondary">psdi_data_conversion.converter.run_converter</code>
    - see the <code class="secondary">help()</code> of this function and/or find
    documentation in the project’s README.
  </li>
</ul>

<h2>Documentation</h2>

<ul>
  <li>
    <a href="https://github.com/PSDI-UK/psdi-data-conversion/blob/main/README.md">README</a>
  </li>
  <li>
    <a href="https://psdi-uk.github.io/psdi-data-conversion/">Code Documentation</a>
  </li>
</ul>
{% endblock %}