نام (NAME)

regina-python - رابط خط فرمانی پایتون برای نرم‌افزار Regina

خلاصه دستور (SYNOPSIS)

regina-python [ -q, --quiet | -v, --verbose ] [ -n, --nolibs ] [ -a, --noautoimport ]

regina-python [ -q, --quiet | -v, --verbose ] [ -n, --nolibs ] [ -a, --noautoimport ] [ -i, --interactive ] script [ script-args ]

توضیحات (DESCRIPTION)

نرم‌افزار Regina یک بستهٔ نرم‌افزاری برای مطالعهٔ مثلث‌بندی‌های ۳-خمینه (3-manifold triangulations) و سطوح نرمال (normal surfaces) است. از دیگر ویژگی‌های کلیدی آن می‌توان به ساختارهای زاویه‌ای، سرشماری و شمارش، بازشناسی ترکیبیاتی مثلث‌بندی‌ها، و وظایف سطح‌بالا مانند بازشناسی ۳-کره و تجزیه به مجموع همبند اشاره کرد. Regina به همراه یک رابط گرافیکی کاربر کامل ارائه می‌شود و همچنین اتصالات (bindings) پایتون و یک رابط برنامه‌نویسی سطح‌پایین C++ را فراهم می‌سازد.

این دستور یک نشست تعاملی پایتون را برای Regina آغاز می‌کند. این نشست یک جلسهٔ خط فرمانی پایتون همراه با ورودی/خروجی متنی مستقیم و فاقد رابط گرافیکی کاربر خواهد بود. تمامی شیءها، کلاس‌ها و متدهای موتور ریاضیاتی Regina از طریق ماژول regina در دسترس خواهند بود که هنگام راه‌اندازی درون‌ریزی می‌شود (مشابه با اجرای دستور import regina). علاوه بر این، مگر در صورتی که گزینهٔ --noautoimport تعیین شده باشد، همهٔ شیءها، کلاس‌ها و متدهای Regina مستقیماً در فضای نام فعلی درون‌ریزی می‌شوند (مشابه با اجرای دستور from regina import *).

به جای شروع یک نشست تعاملی پایتون، می‌توانید یک اسکریپت پایتون را (در صورت نیاز به همراه آرگومان‌ها) ارسال کنید. در این حالت، Regina اسکریپت را اجرا خواهد کرد (پس از درون‌ریزی اولیهٔ ماژول regina). اگر گزینهٔ --interactive را ارسال کنید، Regina پس از پایان اجرای اسکریپت شما را در اعلان پایتون باقی می‌گذارد؛ در غیر این صورت از پایتون خارج شده و شما را به خط فرمان بازمی‌گرداند.

گزینه‌ها (OPTIONS)

-q
--quiet: اجرا در حالت بی‌صدا. به جز خطاهای بحرانی هیچ خروجی دیگری تولید نخواهد شد. به‌ویژه، هشدارها نادیده گرفته می‌شوند.
این گزینه معادل تنظیم متغیر محیطی REGINA_VERBOSITY=0 است.
-v
--verbose: اجرا در حالت پرگو. اطلاعات تشخیصی تکمیلی در خروجی نمایش داده خواهد شد.
این گزینه معادل تنظیم متغیر محیطی REGINA_VERBOSITY=2 است.
-a
--noautoimport: همچنان ماژول regina درون‌ریزی می‌شود، اما تمام شیءها، کلاس‌ها و متدهای Regina به‌طور خودکار به فضای نام جاری درون‌ریزی نخواهند شد (یعنی دستور from regina import * اجرا نمی‌شود). این بدان معناست که (به‌عنوان مثال) کلاس اصلی مثلث‌بندی ۳-خمینه باید به‌صورت regina.Triangulation3 فراخوانی شود، نه فقط Triangulation3.
-i
--interactive: اجرای اسکریپت در حالت تعاملی. پس از اجرای اسکریپت مشخص‌شده، Regina شما را درون مفسر پایتون باقی می‌گذارد تا دستورهای تکمیلی مورد نظرتان را اجرا کنید.
این گزینه تنها زمانی قابل استفاده است که یک اسکریپت ارسال شده باشد. اگر اسکریپتی ارسال نشود، regina-python همواره در حالت تعاملی آغاز به کار می‌کند.

متغیرهای محیطی (ENVIRONMENT VARIABLES)

متغیرهای محیطی زیر بر رفتار این برنامه تأثیر می‌گذارند. اکثر متغیرها را می‌توان در فایل پیکربندی محلی ~/.regina-python نیز با استفاده از سطری به شکل option=value تنظیم کرد؛ موارد استثنا در ادامه ذکر شده‌اند. متغیرهای محیطی نسبت به مقادیر موجود در فایل پیکربندی اولویت دارند.

REGINA_VERBOSITY: مشخص می‌کند چه مقدار خروجی باید تولید شود. مقادیر معتبر عبارتند از:

0: تنها نمایش خطاها؛ این حالت معادل تعیین گزینهٔ --quiet است.
1: نمایش خطاها و هشدارها؛ این مقدار پیش‌فرض است.
2: نمایش خطاها، هشدارها و خروجی‌های تشخیصی؛ این حالت معادل تعیین گزینهٔ --verbose است.

REGINA_PYTHON

دستوری که برای اجرای مفسر پایتون استفاده می‌شود.

به‌طور کلی باید از همان نسخه‌ای از پایتون استفاده کنید که Regina در برابر آن ساخته شده است؛ در غیر این صورت ممکن است پایتون نتواند ماژول regina را بارگذاری کند.

معمولاً نیازی نیست این گزینه را به صورت دستی تنظیم کنید. به‌طور پیش‌فرض، Regina از همان نصب پایتونی استفاده می‌کند که با آن ساخته شده است.

REGINA_PYLIBDIR

دایرکتوری حاوی ماژول پایتون regina.

اگر ماژول پایتون Regina را در یک مسیر استاندارد پایتون نصب کرده‌اید (به‌طوری که پایتون بتواند آن را بدون افزودن به sys.path مستقیماً درون‌ریزی کند)، متغیر REGINA_PYLIBDIR باید خالی یا تعریف‌نشده باقی بماند.

معمولاً نیازی نیست این گزینه را به صورت دستی تنظیم کنید. این برنامه در شرایط استاندارد می‌داند چگونه ماژول پایتون Regina را پیدا کند؛ از جمله در نصب‌های با ساختار فایل‌سیستم ثابت (مانند GNU/Linux و Windows)، بسته‌های برنامک جابه‌جاشدنی (مانند macOS)، و هنگام اجرای مستقیم از شاخهٔ کد منبع.

REGINA_HOME

دایرکتوری‌ای که فایل‌های دادهٔ Regina در زیر آن نصب شده‌اند. به‌ویژه، روتین‌های جستجوی سرشماری Regina پایگاه‌های دادهٔ سرشماری را در زیرشاخهٔ $REGINA_HOME/data/census/ جستجو خواهند کرد.

این گزینه فقط از طریق متغیر محیطی قابل تنظیم است و نمی‌توان آن را در فایل پیکربندی ~/.regina-python تعریف کرد.

معمولاً نیازی نیست این گزینه را به صورت دستی تنظیم کنید. این برنامه در شرایط استاندارد می‌داند چگونه فایل‌های دادهٔ خود را پیدا کند؛ از جمله در نصب‌های با ساختار فایل‌سیستم ثابت (مانند GNU/Linux و Windows)، بسته‌های برنامک جابه‌جاشدنی (مانند macOS)، و هنگام اجرای مستقیم از شاخهٔ کد منبع.

کاربران MACOS (MACOS USERS)

اگر نسخهٔ بستهٔ برنامک کشیدنی و رهاکردنی (drag-and-drop) را بارگیری کرده‌اید، این ابزار درون آن قرار دارد. چنانچه Regina را به دایرکتوری اصلی Applications منتقل کرده باشید، می‌توانید آن را به صورت /Applications/Regina.app/Contents/MacOS/regina-python اجرا کنید.

کاربران WINDOWS (WINDOWS USERS)

دستور regina-python تحت Windows در دسترس نیست. با این حال، همچنان می‌توانید با باز کردن کنسول پایتون در رابط گرافیکی کاربر Regina یا استفاده از بسته‌های اسکریپت (script packets)، از قابلیت‌های اسکریپت‌نویسی پایتون بهره ببرید.

همچنین ببینید (SEE ALSO)

regina-gui.

نرم‌افزار Regina به همراه مستندات کامل API عرضه می‌شود که تمامی شیءها، کلاس‌ها و متدهای در دسترس قرارگرفته در پایتون را با جزئیات تشریح می‌کند. می‌توانید از طریق مسیر Help->Python API Reference در رابط گرافیکی کاربر به این مستندات دسترسی پیدا کنید، یا آن را به‌صورت برخط در نشانی http://regina-normal.github.io/engine-docs مطالعه نمایید.

نویسندگان (AUTHORS)

افراد زیادی در توسعهٔ نرم‌افزار Regina مشارکت داشته‌اند؛ برای مشاهدهٔ فهرست کامل اسامی به کتابچهٔ راهنمای کاربران مراجعه کنید.