Usage
=====

Basic Usage
-----------

1. Prepare your input file (csv, xlsx, txt, tsv) with at least a 'word' column.
2. Open a terminal and navigate to the Jiwar directory.
3. Run the command: ``python jiwar.py``
4. Follow the prompts to select your language, input file, and desired measures.

Example Scenarios
-----------------

Scenario 1: Calculating All Measures for English Words
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Prepare an input file named ``english_words.csv`` with a 'word' column.
2. Run: ``python jiwar.py``
3. When prompted, enter:

   - Language: ``English`` or ``en-us``
   - Use built-in corpus: ``y`` (short for 'yes')
   - Input file: ``C:/documents/jiwar/data/input/english_words.csv``
   - Measures: ``all``

Scenario 2: Calculating Only Orthographic Measures for Spanish Words
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Prepare an input file named ``spanish_words.csv`` with a 'word' column.
2. Run: ``python jiwar.py``
3. When prompted, enter:

   - Language: ``Spanish`` or ``es``
   - Use built-in corpus: ``y`` (short for 'yes')
   - Input file: ``C:/documents/jiwar/data/input/spanish_words.csv``
   - Measures: ``orth``

Scenario 3: Using a Custom Corpus for Hindi
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Prepare your custom Hindi corpus and save it as ``hindi_corpus.csv`` in the ``data/corpus/user_loaded/`` directory. The :doc:`custom corpus <languages/custom_corpus>` must include a 'word' column.
2. Prepare your input file named ``hindi_words.csv`` with a 'word' column.
3. Run: ``python jiwar.py``
4. When prompted, enter:

   - Language: ``Hindi`` or ``hi``
   - Use built-in corpus: ``n`` (short for 'no'; since Hindi doesn't have a built-in corpus)
   - Custom corpus filename: ``hindi_corpus.csv``
   - Input file: ``C:/documents/jiwar/data/input/hindi_words.csv``
   - Measures: Choose your desired measures (e.g., ``all``, ``orth,phon``, etc.)

Tips
----

- If you're unsure about the supported languages or measures, type ``help`` at any prompt for more information.
- To exit the program at any time, type ``exit`` at any prompt.
- For languages without built-in IPA support, consider adding an 'IPA' column to your custom corpus for the generation of phonological and phonographic measures.

For more information on specific measures, see :doc:`measures/index`.
For language support details, see :doc:`languages/index`.