<commit_before>.. _section-installation-makahiki-vagrant-quickstart:

Quick Start Guide: Makahiki on Vagrant 
======================================

If you have not already installed VirtualBox and Vagrant and downloaded the Makahiki source code, 
complete :ref:`section-installation-makahiki-vagrant-environment-setup` before completing this section.

.. note::
   Throughout this guide, a "``>``" indicates a command prompt on the host OS.
   
.. note::
   The "``makahiki>``" prompt indicates that the working directory is in the 
   "Makahiki directory" on the host machine. The file path preceding "makahiki"
   (e.g., "``C:\Users\username\Vagrant\makahiki>``") will be different depending 
   on the location of the directory in the file system.

If a Command Prompt (Windows) or Terminal (OS X and Linux) shell is not open on 
your host machine, open one.

Set up Makahiki in the Virtual Machine
--------------------------------------

In your Command Prompt or Terminal, switch your working directory to the
"makahiki" directory that was created in :ref:`section-installation-makahiki-vagrant-environment-setup`::

  > cd <path-to-makahiki>\makahiki
  
Replace ``<path-to-makahiki>`` with the file system path to the "makahiki" directory. On Windows, if 
your "makahiki" directory is located at ``C:\Users\username\Vagrant\makahiki``, you would use the command 
``cd C:\Users\username\Vagrant\makahiki`` here. On Linux, if your "makahiki" directory is at 
``/home/username/vagrant/makahiki``, you would use the command ``cd /home/username/vagrant/makahiki`` here.
  
The "makahiki" directory contains the Vagrantfile which defines the settings 
of the Vagrant virtual machine.

Use the ``vagrant up`` command to start the virtual machine for the first time::

  makahiki> vagrant up
  
.. warning:: Windows users may see multiple warnings while ``vagrant up`` is running for the first time.

     * **A Windows Firewall warning about vboxheadless.exe**: This application should be allowed.
     * **VirtualBox is attempting to make changes to the system**: This should be allowed. It is needed for Vagrant / VirtualBox host-only networking to work.
      
.. warning:: If you are not starting Vagrant for the first time and do not want to lose 
   your configuration, start Vagrant with ``--no-provision``::
   
     makahiki> vagrant up --no-provision

   Each time Vagrant is started with ``vagrant up``, it will run the 
   ``run_bootstrap.sh`` provisioning script specified in the Vagrantfile. This 
   script:
   <commit_msg>Update installation-makahiki-vagrant-quickstart.rst: Undid unnecessary change to "/" from last edit.<commit_after>.. _section-installation-makahiki-vagrant-quickstart:

Quick Start Guide: Makahiki on Vagrant 
======================================

If you have not already installed VirtualBox and Vagrant and downloaded the Makahiki source code, 
complete :ref:`section-installation-makahiki-vagrant-environment-setup` before completing this section.

.. note::
   Throughout this guide, a "``>``" indicates a command prompt on the host OS.
   
.. note::
   The "``makahiki>``" prompt indicates that the working directory is in the 
   "Makahiki directory" on the host machine. The file path preceding "makahiki"
   (e.g., "``C:\Users\username\Vagrant\makahiki>``") will be different depending 
   on the location of the directory in the file system.

If a Command Prompt (Windows) or Terminal (OS X and Linux) shell is not open on 
your host machine, open one.

Set up Makahiki in the Virtual Machine
--------------------------------------

In your Command Prompt or Terminal, switch your working directory to the
"makahiki" directory that was created in :ref:`section-installation-makahiki-vagrant-environment-setup`::

  > cd <path-to-makahiki>/makahiki
  
Replace ``<path-to-makahiki>`` with the file system path to the "makahiki" directory. On Windows, if 
your "makahiki" directory is located at ``C:\Users\username\Vagrant\makahiki``, you would use the command 
``cd C:\Users\username\Vagrant\makahiki`` here. On Linux, if your "makahiki" directory is at 
``/home/username/vagrant/makahiki``, you would use the command ``cd /home/username/vagrant/makahiki`` here.
  
The "makahiki" directory contains the Vagrantfile which defines the settings 
of the Vagrant virtual machine.

Use the ``vagrant up`` command to start the virtual machine for the first time::

  makahiki> vagrant up
  
.. warning:: Windows users may see multiple warnings while ``vagrant up`` is running for the first time.

     * **A Windows Firewall warning about vboxheadless.exe**: This application should be allowed.
     * **VirtualBox is attempting to make changes to the system**: This should be allowed. It is needed for Vagrant / VirtualBox host-only networking to work.
      
.. warning:: If you are not starting Vagrant for the first time and do not want to lose 
   your configuration, start Vagrant with ``--no-provision``::
   
     makahiki> vagrant up --no-provision

   Each time Vagrant is started with ``vagrant up``, it will run the 
   ``run_bootstrap.sh`` provisioning script specified in the Vagrantfile. This 
   script:
   
{'fraction_non_alphanumeric': 0.11519845111326234, 'fraction_numerical': 0.0, 'mean_word_length': 3.837078651685393, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2487490', 'n_tokens_mistral': 1520, 'n_tokens_neox': 1445, 'n_words': 620}