Skip to content

Commit 8b6b2a2

Browse files
committed
moving note to below
1 parent 2ac4624 commit 8b6b2a2

1 file changed

Lines changed: 32 additions & 7 deletions

File tree

utils/examples.ipynb

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@
2828
"id": "1d78f3a3",
2929
"metadata": {},
3030
"source": [
31-
"The import syntax above ensures that the online documentation grabs the latest version. For you, it should just be `import precession`, and in case you want to use the eccentric version, import `precession.eccentricity`.\n",
32-
"*Note for the usage of the eccentric version of* `precession`: The code is implemented such that almost all the functions available in `precession` can be accessed by just importing its eccentric extension. Some of them are exactly the same as for the circular counterpart; others, specifically those directly involving time or orbital separation, require a different input (briefly, all `r` parameters have been substituted with `(a, e)`). The functions that are specific only to the circular case (like `eval_r` or those related to the remnant properties) cannot be accessed via `precession.eccentricity`. "
31+
"The import syntax above ensures that the online documentation grabs the latest version. For you, it should just be `import precession` for the main code that deals with quasi-circular binaries. If you're using the eccentric version, we reccommend importin with `import precession.eccentricity as precession`."
3332
]
3433
},
3534
{
@@ -461,7 +460,9 @@
461460
"cell_type": "markdown",
462461
"id": "b110ca2c",
463462
"metadata": {},
464-
"source": []
463+
"source": [
464+
"*Note when using the eccentric version of* `precession`: The code is implemented such that almost all functions available in `precession` can be accessed by simply importing its eccentric extension. Some of them are exactly the same as in the circular counterpart; others—specifically those directly involving time or orbital separation—require different inputs (briefly: all `r` parameters have been replaced with `(a, e)`). Functions that are specific to the circular case only (such as `eval_r` or those related to remnant properties) cannot be accessed via `precession.eccentricity`."
465+
]
465466
},
466467
{
467468
"cell_type": "markdown",
@@ -473,10 +474,22 @@
473474
},
474475
{
475476
"cell_type": "code",
476-
"execution_count": 17,
477+
"execution_count": 1,
477478
"id": "704e45f5",
478479
"metadata": {},
479-
"outputs": [],
480+
"outputs": [
481+
{
482+
"ename": "NameError",
483+
"evalue": "name 'np' is not defined",
484+
"output_type": "error",
485+
"traceback": [
486+
"\u001b[31m---------------------------------------------------------------------------\u001b[39m",
487+
"\u001b[31mNameError\u001b[39m Traceback (most recent call last)",
488+
"\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[1]\u001b[39m\u001b[32m, line 2\u001b[39m\n\u001b[32m 1\u001b[39m \u001b[38;5;66;03m#intial semi major axis ( in geometric units)\u001b[39;00m\n\u001b[32m----> \u001b[39m\u001b[32m2\u001b[39m \u001b[43mnp\u001b[49m.random.seed(\u001b[32m42\u001b[39m)\n\u001b[32m 3\u001b[39m a0= \u001b[32m100\u001b[39m\n\u001b[32m 4\u001b[39m \u001b[38;5;66;03m#final semi major axis\u001b[39;00m\n",
489+
"\u001b[31mNameError\u001b[39m: name 'np' is not defined"
490+
]
491+
}
492+
],
480493
"source": [
481494
"#intial semi major axis ( in geometric units)\n",
482495
"np.random.seed(42)\n",
@@ -490,10 +503,22 @@
490503
},
491504
{
492505
"cell_type": "code",
493-
"execution_count": 18,
506+
"execution_count": 2,
494507
"id": "5550eac0",
495508
"metadata": {},
496-
"outputs": [],
509+
"outputs": [
510+
{
511+
"ename": "NameError",
512+
"evalue": "name 'np' is not defined",
513+
"output_type": "error",
514+
"traceback": [
515+
"\u001b[31m---------------------------------------------------------------------------\u001b[39m",
516+
"\u001b[31mNameError\u001b[39m Traceback (most recent call last)",
517+
"\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[2]\u001b[39m\u001b[32m, line 2\u001b[39m\n\u001b[32m 1\u001b[39m \u001b[38;5;66;03m#spin parameters\u001b[39;00m\n\u001b[32m----> \u001b[39m\u001b[32m2\u001b[39m chi1 =\u001b[43mnp\u001b[49m.random.uniform(\u001b[32m0.1\u001b[39m, \u001b[32m1\u001b[39m)\n\u001b[32m 3\u001b[39m chi2 =np.random.uniform(\u001b[32m0.1\u001b[39m, \u001b[32m1\u001b[39m)\n\u001b[32m 4\u001b[39m theta1, theta2, deltaphi = precession_eccentricity.isotropic_angles(N=\u001b[32m1\u001b[39m)\n",
518+
"\u001b[31mNameError\u001b[39m: name 'np' is not defined"
519+
]
520+
}
521+
],
497522
"source": [
498523
"#spin parameters\n",
499524
"chi1 =np.random.uniform(0.1, 1)\n",

0 commit comments

Comments
 (0)