<commit_before>PyZDDE: Python Zemax Dynamic Data Exchange
------------------------------------------

|DOI|

Current revision
'''''''''''''''''

2.0.0a1 (Last significant update on 07/25/2015)

Change log
~~~~~~~~~~
Brief change-log is available in the `News and
Updates <https://github.com/indranilsinharoy/PyZDDE/wiki/News-and-updates>`__
page.


Install PyZDDE from PyPI
''''''''''''''''''''''''

You can either use `pip <https://pip.pypa.io/en/stable/>`__ or the ``setup.py`` script 
from the extracted folder.

Use the following command from the command line to install PyZDDE from PyPI:

.. code:: python

  pip install pyzdde

Note that when you install PyZDDE using pip (the above method), the "Examples" folder 
will not be downloaded. However, pip is the most convenient way to install Python packages.
Also, ensure that you have the `pip` package in your environment. 

If you would like to download the "Examples" folder too, please download and extract PyZDDE 
package from the `Python Package Index <https://pypi.python.org/pypi/PyZDDE>`__. Then,  
``cd`` into the extracted folder where the ``setup.py`` script is visible and execute 
the following in a command prompt:

.. code:: python

  python setup.py install

If you would like to see what files were added and where you may use:

.. code:: python

  python setup.py install --record files.txt

A list of all files that were added and their locations will be available in the 
file "files.txt" in the same directory.  


To get the latest PyZDDE code please download (or fork or clone) from 
`GitHub repository <https://github.com/indranilsinharoy/PyZDDE>`__.


Documentation
'''''''''''''

The PyZDDE documentation is currently hosted in the `GitHub Wiki <https://github.com/indranilsinharoy/PyZDDE/wiki>`__.

<commit_msg>added info. about installing pre-release from pypi<commit_after>PyZDDE: Python Zemax Dynamic Data Exchange
------------------------------------------

|DOI|

Current revision
'''''''''''''''''

2.0.0a1 (Last significant update on 07/25/2015)

Change log
~~~~~~~~~~
Brief change-log is available in the `News and
Updates <https://github.com/indranilsinharoy/PyZDDE/wiki/News-and-updates>`__
page.


Install PyZDDE from PyPI
''''''''''''''''''''''''

You can either use `pip <https://pip.pypa.io/en/stable/>`__ or the ``setup.py`` script 
from the extracted folder.

Use the following command from the command line to install PyZDDE from PyPI:

.. code:: python

  pip install pyzdde


Note 1. By default only the latest stable version is installed by default, using
the above command. To install pre-release versions add the 
`--pre <https://pip.pypa.io/en/latest/reference/pip_install.html#pre-release-versions>`__
flag:

.. code:: python
  
  python install pyzdde --pre  


Note 2. When you install PyZDDE using pip (the above method), the "Examples" folder 
will not be downloaded. However, pip is the most convenient way to install Python packages.
Also, ensure that you have the `pip` package in your environment. 

If you would like to download the "Examples" folder too, please download and extract PyZDDE 
package from the `Python Package Index <https://pypi.python.org/pypi/PyZDDE>`__. Then,  
``cd`` into the extracted folder where the ``setup.py`` script is visible and execute 
the following in a command prompt:

.. code:: python

  python setup.py install

If you would like to see what files were added and where you may use:

.. code:: python

  python setup.py install --record files.txt

A list of all files that were added and their locations will be available in the 
file "files.txt" in the same directory.  

Note 3. To uninstall pyzdde using pip use

.. code:: python

  python uninstall pyzdde


LATEST CODE:


To get the latest PyZDDE code please download (or fork or clone) from 
`GitHub repository <https://github.com/indranilsinharoy/PyZDDE>`__.


Documentation
'''''''''''''

The PyZDDE documentation is currently hosted in the `GitHub Wiki <https://github.com/indranilsinharoy/PyZDDE/wiki>`__.


{'fraction_non_alphanumeric': 0.12814132868872855, 'fraction_numerical': 0.006718089076884797, 'mean_word_length': 3.7238542890716806, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '588670', 'n_tokens_mistral': 1275, 'n_tokens_neox': 1198, 'n_words': 499}