Rilis hidrokit 0.2.0
Enam bulan yang lalu, saya merilis hidrokit 0.1.0. Pada saat itu, banyak sekali kekurangan dari segi dokumentasi maupun teknis sehingga cukup sulit untuk memulai berkontribusi bagi yang tertarik untuk ikut serta dalam proyek open-source ini. Dengan rilis 0.2.0, saya mencoba menjawab permasalahan tersebut dengan menyertai berbagai fitur untuk paket python hidrokit maupun dokumentasi sehingga memudahkan berkontribusi bagi yang tertarik dengan proyek ini.
Pengenalan
Hidrokit merupakan proyek open-source paket/package python yang dapat digunakan untuk membantu proses analisis hidrologi berupa pengolahan data, analisis data, dan visualisasi data. Saat ini, proyek ini masih dalam tahap pengembangan, sehingga untuk penggunaan praktis belum memadai. Proyek ini cocok bagi yang tertarik untuk ikut serta dalam proyek open-source karena masih dalam tahap awal pengembangan. Dengan proyek ini, hidrokit juga bertujuan membangun komunitas pengguna python (jupyter notebook) dan para praktisi atau akademisi yang memanfaatkan python dalam bidang hidrologi.
Baca abstrak dan tujuan hidrokit untuk informasi lebih lanjut.
Jika ingin langsung melihat kegunaan hidrokit (python dan jupyter notebook) bisa lihat contoh notebook berikut:
- Prediksi Kualitas Air menggunakan Metode Artificial Neural Networks oleh taruma. Lihat melalui NBViewer.
- Daftar tutorial fungsi/modul pada hidrokit dapat dilihat di halaman ini.
Jika Anda tertarik berkontribusi pada proyek ini, baca bagian kontribusi. Proyek ini terbuka untuk berbagai latar belakang dan tingkat keahlian. Saya juga telah membuat tanya jawab seputar proyek ini pada bagian FAQ.
Apa yang baru di hidrokit 0.2.0?
Pada hidrokit 0.2.0, pengembangan python diusahakan untuk mengikuti standar yang ada dimulai dari packaging, versioning, testing, dan continous integration. Hal tersebut mengakibatkan hidrokit 0.2.0 tidak backward-compatibility dengan hidrokit 0.1.x. Diharapkan dengan struktur sekarang, hidrokit 0.2.0 memiliki kapasitas untuk forward-compatibility dan memudahkan bagi developer mengembangkan fitur baru atau memperbaiki fitur.
Dengan rilisnya hidrokit 0.2.0, diperkenalkan tiga situs utama yang berhubungan dengan proyek ini.
- hidrokit.online: Situs resmi proyek hidrokit yang berisikan dokumentasi berupa tentang hidrokit (tujuan/abstrak), tutorial/panduan berkontribusi, dll.
- notebook.hidrokit.online: Situs pelengkap yang berisikan kumpulan jupyter notebook mengenai penggunaan hidrokit dan pemanfaatan python dalam bidang hidrologi.
- hidrokit.readthedocs.io: Situs berbahasa inggris yang digunakan sebagai dokumentasi teknis berisikan daftar lengkap Application Programming Interface (API) yang tersedia di proyek hidrokit. Situs ini ditujukan untuk pengembang / developer.
Dibuatnya situs agar memudahkan akses informasi melalui berbagai media (komputer, telepon genggam). Navigasi dan tampilan pada situs juga lebih mudah dibandingkan melalui halaman github karena halaman github lebih ditujukan untuk developer.
Berikut daftar perubahan di hidrokit 0.2.0
hidrokit 0.2.0
Perubahan berikut ditujukan untuk membuat proyek hidrokit lebih terstruktur dan lebih mudah untuk dikembangkan lebih lanjut. Berikut perubahan penting hidrokit 0.1.x ke 0.2.0:
Baru
- Paket dibagi menjadi tiga subpaket (subpackage) utama yaitu persiapan (
hidrokit.prep), analisis (hidrokit.analysis), dan visualisasi (hidrokit.viz). - Integrasi travis-ci, codecov, codacy.
- Testing menggunakan pytest dengan 90%+ coverage.
- Situs khusus untuk dokumentasi teknis di hidrokit.readthedocs.io yang berisikan daftar API hidrokit dibangkitkan menggunakan docstring.
Perubahan
- Penamaan modul dan fungsi diubah dan disesuaikan dengan standar PEP8.
- Fungsi pada modul berikut digantikan dengan modul baru dibawah subpaket baru.
| Modul di 0.1.x | 0.2.0 |
|---|---|
dlkit |
prep.timeseries dan viz.graph |
viewkit |
viz.table |
prepkit |
prep.excel |
datakit |
prep.read |
- Perubahan nama fungsi agar lebih jelas dan mengubah fungsi yang bukan ditujukan untuk penggunaan menjadi private function.
- Seluruh fungsi pada
prepkityang berfungsi membaca berkas excel, untuk sementara menjadi private function. - Perubahan nama fungsi pada
dlkitdandatakit.
- Seluruh fungsi pada
| Nama Fungsi di 0.1.x | 0.2.0 |
|---|---|
dlkit.plot_dataset |
viz.graph.subplots |
datakit.dict_null_data |
prep.read.missing_row |
| Fungsi column timesteps | prep.timeseries.timestep_table |
- dlkit.single_column_timesteps |
private |
- dlkit.multi_column_timesteps |
private |
Penghilangan
- Modul
bmkgkitdihapuskan dan tidak digantikan. - Modul berikut ini telah dihapus/digantikan sehingga tidak dapat digunakan lagi:
dlkit,viewkit,bmkgkit,prepkit,datakit.
Situs hidrokit
Situs hidrokit digunakan sebagai situs utama untuk memperoleh informasi mengenai proyek ini. Situs ini dibuat menggunakan Jekyll dan Github Pages hosting. Repository situs dapat diakses di cabang gh-pages.
Berikut halaman penting yang tersedia pada situs hidrokit:
| Halaman | Keterangan |
|---|---|
| tentang-hidrokit | Abstrak dan Tujuan hidrokit. Dorongan untuk berkontribusi. |
| berkontribusi | Informasi umum untuk memulai berkontribusi. |
| kode-etik | Kode etik dalam proyek. |
| instalasi | Pemasangan/instalasi paket hidrokit. |
| penggunaan | Penggunaan paket hidrokit. |
| sumber | Daftar sumber yang digunakan dalam proyek. |
Situs Hidrokit Notebook
Situs Hidrokit digunakan sebagai situs pelengkap yang berisikan kumpulan jupyter notebook mengenai penggunaan hidrokit dan pemanfaatan python dalam bidang hidrologi. Situs ini dibuat menggunakan Jekyll dan Github Pages hosting. Repository situs dapat diakses di hidrokit-nb.
Berikut halaman penting yang tersedia pada situs Hidrokit Notebook:
| Halaman | Keterangan |
|---|---|
| kumpulan-notebook | Daftar kumpulan notebook yang telah dikategorikan dan tersedia. |
| mengunggah-notebook | Panduan upload/mengunggah notebook. |
| lisensi-notebook | Keterangan lisensi notebook. |
| pull-request | Panduan lanjutan untuk memperbarui repo dan melakukan pull request berikutnya. |
| tambah-notebook | Panduan menambah notebook ke halaman kumpulan-notebook. |
| unduh-notebook | Panduan mengunduh notebook. |
Berkontribusi
Seluruh yang disebutkan pada proyek ini berupa paket python hidrokit, situs hidrokit, situs Hidrokit Notebook, situs readthedocs bersifat open-source sehingga Anda bisa mengajukan perubahan, berkontribusi, atau bahkan Anda bisa mengembangkannya sebagai proyek Anda sendiri. Karena seluruh proyek ini menggunakan MIT License dan CC-BY-4.0 kecuali disebutkan secara terpisah seperti pada notebook.
Panduan umum untuk berkontribusi dapat dibaca pada halaman berkontribusi.
Proyek ini berusaha memberi wadah bagi individu yang tertarik berkontribusi di proyek open-source dari berbagai latar belakang. Seperti yang dijelaskan pada halaman how to contribute, Anda dapat berkontribusi pada proyek selain implementasi kode. Proyek ini juga memberi kesempatan dari berbagai tingkat keahlian. Ilustrasi berkontribusi di Github:
- Jika Anda seorang praktisi/akademisi di bidang hidrologi, Anda bisa menyampaikan ide/fitur yang cocok disertakan di proyek ini, berdiskusi tentang impelementasi pada python, dll.
- Jika Anda tetarik pada pengembangan web, Anda bisa memberikan ide desain situs, menyarankan tema yang sesuai, mengembangkan tema Jekyll yang sesuai dengan proyek ini, bereksperimen dengan Jekyll dan Github Pages. Ada dua situs yaitu hidrokit dan hidrokit-notebook, jadi ada wadah bereksperimen atau berkontribusi pada proyek ini bagi yang tertarik.
- Jika Anda tertarik pada pengembangan python, Anda bisa mengevaluasi implementasi kode, menerapkan fitur, refactoring kode, dll.
- Jika Anda tertarik pada dokumentasi, Anda bisa menyunting penulisan situs, memperbaiki penulisan agar lebih jelas, menerjemahkan, dll.
- Jika Anda tertarik pada memperkenalkan/pengajaran, Anda bisa membuat tutorial dengan python/jupyter notebook dan mengunggahnya di hidrokit-notebook.
- Jika Anda memiliki kode python yang cocok dengan proyek ini, Anda bisa menguploadnya pada github Anda dan menyarankan untuk diimplementasikan dalam proyek ini.
- Jika Anda tertarik merancang logo, jangan ragu untuk menyampaikannya di proyek ini.
- Jika Anda tertarik pada aspek komunitas, Anda bisa mengajak acara meet-up komunitas hidrokit.
- Jika Anda menyukai mengorganisir, Anda bisa membantu mengorganisasikan isu/diskusi di github.
- Jika Anda baru belajar/mengenal python/jupyter/proyek ini, Anda bisa bertanya, berdiskusi, dan berbagi pengalaman Anda di proyek ini.
- Jika Anda memiliki pengalaman terkait proyek ini, Anda bisa berbagi pengalaman Anda.
- Jika Anda hanya menggunakan proyek/situs ini, Anda juga bisa berkontribusi dengan melaporkan kerusakan/kekeliruan/koreksi.
Intinya, kalau ada ide jangan dibiarkan terbang, buat isu/diskusi di github sekarang juga.
Frequently Asked Questions
Saya akan berusaha menjawab pertanyaan yang mungkin menjadi perhatian/pertimbangan.
Siapa dibalik proyek hidrokit?
Proyek hidrokit dibuat dan dimulai oleh Taruma Sakti Megariansyah (saya sendiri. 😁). Saya merupakan lulusan sarjana teknik sipil dari Universitas Katolik Parahyangan, Bandung angkatan 2008. Saya tidak memiliki pengalaman kerja baik di bidang hidrologi atau bidang komputer (python), jadi proyek ini akan jauh dari sempurna atau tepat sasaran. 😅.
Apakah proyek ini bagian dari tugas/kerjaan?
Proyek hidrokit, murni merupakan proyek hobi dan pribadi.
Proyek ini bukan:
- Bagian dari pekerjaan (yang tidak saya miliki 😉)
- Untuk menyelesaikan kewajiban akademis (tugas akhir/tesis)
- Permintaan dari perusahaan / konsultan / praktisi / akademisi / individu.
Keuntungan apa yang segera didapatkan jika menggunakan hidrokit?
hidrokit bukan program yang berfungsi memasukkan input data kemudian langsung memperoleh output data atau laporan. Sehingga tidak bisa “segera” diuntungkan saat beralih ke penggunaan hidrokit/python.
Jika Anda telah menggunakan python dan jupyter notebook pada alur kerja Anda, kemungkinan paket hidrokit bisa mempersingkat/mempercepat alur kerja tersebut. Jadi, sebelum menggunakan hidrokit, diasumsikan sudah terbiasa menggunakan python dan jupyter notebook.
Bagi yang belum tahu python dan jupyter notebook, proyek ini memperkenalkan keuntungan hal tersebut dan membantu Anda memulai petualangan tersebut. Saat tulisan ini dipublikasi, belum ada halaman panduannya, tapi jika Anda membutuhkan bantuan, buat isu/diskusi disini.
Proyek ini hanya memperkenalkan python + jupyter notebook pada umumnya, dan bukan memaksakan untuk beralih dari spreadsheet. Pandangan pribadi saya adalah lebih praktis dan intuitif menggunakan python + jupyter notebook + hidrokit dibandingkan menggunakan spreadsheet.
Sebagai informasi, saya belum memiliki pengalaman kerja di bidang hidrologi atau python/data science. Jadi, saya tidak bisa menjawab dengan tepat dampak positif/negatif proyek ini.
Anda bisa membaca FAQ lanjutannya di halaman Tanya Jawab Rilis Hidrokit 0.2.0.
Terima kasih atas perhatiannya, jika Anda memiliki pertanyaan/kritik/saran mengenai proyek ini Anda bisa membuat isu/diskusi di halaman github. Anda bisa menghubungi saya melalui email di tarumainfo@gmail.com (Email hi@taruma.info sedang bermasalah) (Jika terkait proyek hidrokit, dianjurkan untuk melalui github).
Mengakhiri tulisan ini dengan video inspiratif dari Github.