phox

Phox

Repositori dasar untuk simulasi dan kontrol perangkat fotonik.

Catatan: Modul ini cukup mentah dan saat ini hanya dimaksudkan untuk mereplikasi hasil dalam makalah kami:

Instalasi

Instal di lingkungan Python Anda menggunakan:

pip install -e phox

Anda kemudian dapat mengubah phox jika perlu. Saat mengimpor phox , Anda sekarang dapat memperlakukannya sebagai modul lainnya. Tidak ada pengaturan filepath yang diperlukan karena phox akan ada di direktori site-packages lingkungan Anda.

Alur kerja git

Menambahkan Cabang Fitur Baru

 git pull # update local based on remote
git checkout develop # start branch from develop
git checkout -b feature/feature-branch-name

Lakukan semua pekerjaan di cabang. Setelah perubahan Anda, dari folder root, jalankan yang berikut:

 git add . && git commit -m 'insert your commit message here'

Rebasing dan tarik permintaan

Pertama, Anda perlu mengedit riwayat komit Anda dengan "meremas" komit. Anda harus berada di feature/feature-branch-name . Pertama -tama lihat sejarah komit Anda untuk melihat berapa banyak komit yang telah Anda buat di cabang fitur Anda:

 git log

Hitung jumlah komit yang telah Anda buat dan hubungi N. sekarang, jalankan yang berikut:

 git rebase -i HEAD~N

Squash setiap komitmen yang tidak penting (atau semua berkomitmen ke dalam satu komit jika Anda suka). Tutorial yang bagus disediakan di sini.

Sekarang, Anda harus rebase di atas cabang develop dengan mengeksekusi:

 git rebase develop

Anda perlu menyelesaikan konflik apa pun yang muncul secara manual selama proses rebase ini.

Sekarang Anda akan memaksa cabang ini yang dibangun kembali ini menggunakan:

 git push --set-upstream origin feature/feature-branch-name
git push -f

Maka Anda harus mengirimkan permintaan tarik menggunakan tautan ini.

Memperbarui Kembangkan dan Master

Admin repositori ini bertanggung jawab untuk memperbarui develop (rilis tidak stabil) dan master (rilis stabil). Ini terjadi secara otomatis setelah admin menyetujui permintaan tarik.

 git checkout develop
git merge feature/feature-branch-name

Untuk memperbarui master:

 git checkout master
git merge develop

Sebagai aturan, hanya satu admin yang ditunjuk yang harus memiliki izin untuk melakukan langkah -langkah ini.