English | Bahasa Indonesia

---

📑 Table of Contents

• Introduction
• Features
• Installation Guide
  • Windows
  • Linux
• Usage Example
  • Generate Stacking Chart and Measurement Table
  • Generate Only Measurement Tables
  • Custom Output Directory
• Local Development
• Contributing

---

Introduction

Geolistrik CLI is a command-line utility to generate stacking charts and electrode configuration tables for five common resistivity methods in geophysical survey:

• Wenner-Schlumberger (ws)
• Wenner (wn)
• Pole-Pole (pp)
• Pole-Dipole (pd)
• Dipole-Dipole (dd)

It saves outputs in .png (chart) and .xlsx (data) formats.

---

Features

✅ Support 5 array types
✅ CLI options: --outdir, --no-plot
✅ Output: .png (chart), .xlsx (data)
✅ Windows & Linux standalone builds
✅ Easy to use for students, researchers, and engineers

---

Installation Guide

Windows

📦 Download Installer

1. Run the installer and follow the instructions.

2. After the installation is complete, manually add the following folder:

   C:\Program Files (x86)\Geolistrik
   

   to your system PATH manually. This the tutorial:

   • Click Start, type "env", and select Edit the system environment variables
   • In the System Properties window, click the Environment Variables… button
   • Under the System Variables section, find Path and click Edit
   • In the Edit Environment Variable window, click New to add a new path
   • Close all dialogue boxes by clicking OK to save your changes
   • Restart terminal to ensure the PATH changes take effect

3. Open CMD and type:

   geolistrik

   You'll see the welcome banner:

4. Uninstall:

   • Uninstall via Control Panel → Uninstall a Program
   • Remove the path entry from the system PATH

---

Linux

📦 Download Linux binary

1. Make the file executable
   For example, if the file is in the ~/Downloads folder:

   chmod +x ~/Downloads/geolistrik-linux-1.0.0.bin

2. Move the file to a directory in your PATH Typically this would be ~/.local/bin (for local install) or /usr/local/bin (for global install).

   • Global installation (for all users):

     sudo mv ~/Downloads/geolistrik-linux-1.0.0.bin /usr/local/bin/geolistrik

   • Local installation (for current user only): First, ensure ~/.local/bin is included in your $PATH. Check with:

     echo $PATH

     If it’s not included, add it to your .bashrc or .zshrc:

     echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
     source ~/.bashrc

     If it is already included, simply run:

     mkdir -p ~/.local/bin
     mv ~/Downloads/geolistrik-linux-1.0.0.bin ~/.local/bin/geolistrik

     Now you can use the CLI from anywhere:

     geolistrik

     Just like on Windows, you should see a welcome banner.

3. Uninstall
   Simply delete the binary from your system:

   sudo rm /usr/local/bin/geolistrik

---

Usage Example

geolistrik [config] [min] [max] [spacing] [--outdir DIR] [--no-plot]

Configuration Codes:

Code	Configuration
ws	Wenner-Schlumberger
wn	Wenner
pp	Pole-Pole
pd	Pole-Dipole
dd	Dipole-Dipole

Options:

Option	Description
--outdir	Set output directory for files
--no-plot	Skip plotting .png, just generate data
--version	Show app version
--about	Show app metadata
--update	Update app

Generate Stacking Chart and Measurement Table

By default, this command produces:

• Image file ([config]_[min]_[max]_a[space].png)
• Data table ([config]_[min]_[max]_a[space].xlsx)

Example:

geolistrik ws 0 100 10

This is how the data acquisition process in the field corresponds to the table created:

Generate Only Measurement Tables

Use --no-plot to disable chart generation:

geolistrik ws 0 100 10 --no-plot

Custom Output Directory

Add --outdir to specify output folder:

geolistrik ws 0 100 10 --outdir "./results"

---

Local Development

1. Clone this repository:

   git clone https://github.com/vysf/geolistrik-cli
   cd geolistrik-cli

2. Install dependencies:

   pip install -r requirements.txt

3. Run locally:

   python -m geolistrik --help

4. Build with Nuitka: See build.bat or use:

   nuitka --standalone --onefile --include-package=geolistrik --output-dir=build geolistrik/__main__.py

5. Compile Windows Installer:

   • Requires Inno Setup
   • Run:

     ISCC geolistrik_setup.iss

---

Contributing

PRs are welcome!

How to contribute:

• Fork this repository
• Commit changes to a branch
• Submit a pull request
• Or open an issue to report bugs/suggestions

---

📫 Contact: Yusuf Umar Al Hakim
✉️ yusufumaralhakim@gmail.com
🌐 GitHub Project

Personal Notes

1. development flow
   flag -b artinya create adan switch

git checkout dev master
git checkout -b feature/cli-wizard
# koding...
git commit -m "feat: add CLI wizard command"
git checkout dev
git merge feature/cli-wizard
git push origin dev
# testing oke
git checkout master
git merge dev
git tag v2.0.0
git push origin master --tags

2. next update

geolistrik generate res2d --config wn --min 0 --max 100 --spacing 5 --res-value 200
geolistrik update
geolistrik about
geolistrik wizard
geolistrik --version